Wala shell

Advanced PHP File Manager

Server IP: 127.0.0.1 | PHP Version: 8.3.30 | Domains Hosted: 54

Name	Size	Last Modified	Actions
📁 ..	-	2025-03-11 18:02
📄 compute_2025-01-01-preview.json { "kind": "discovery#restDescription", "discoveryVersion": "v1", "id": "compute:v1", "name": "compute", "version": "2025-01-01-preview", "revision": "20250307", "title": "Compute Engine API", "description": "Creates and runs virtual machines on Google Cloud Platform.", "ownerDomain": "google.com", "ownerName": "Google", "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" }, "documentationLink": "https://cloud.google.com/compute/", "protocol": "rest", "rootUrl": "https://compute.googleapis.com/", "mtlsRootUrl": "https://compute.mtls.googleapis.com/", "servicePath": "compute/v1", "baseUrl": "https://compute.googleapis.com/compute/v1", "batchPath": "batch/compute/v1", "version_module": true, "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "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" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "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" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "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" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "userIp": { "type": "string", "description": "Legacy name for parameter that has been superseded by `quotaUser`.", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "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" } } } }, "schemas": { "OperationList": { "id": "OperationList", "description": "Contains a list of Operation resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always `compute#operations` for Operations resource.", "default": "compute#operationList", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string" }, "items": { "description": "[Output Only] A list of Operation resources.", "type": "array", "items": { "$ref": "Operation" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than `maxResults`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Operation": { "id": "Operation", "description": "Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](\/compute\/docs\/reference\/rest\/v2\/globalOperations) * [Regional](\/compute\/docs\/reference\/rest\/v2\/regionOperations) * [Zonal](\/compute\/docs\/reference\/rest\/v2\/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.", "type": "object", "properties": { "setCommonInstanceMetadataOperationMetadata": { "description": "[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.", "$ref": "SetCommonInstanceMetadataOperationMetadata" }, "instancesBulkInsertOperationMetadata": { "$ref": "InstancesBulkInsertOperationMetadata" }, "kind": { "description": "[Output Only] Type of the resource. Always `compute#operation` for Operation resources.", "default": "compute#operation", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the operation. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Deprecated] This field is deprecated.", "type": "string" }, "name": { "description": "[Output Only] Name of the operation.", "type": "string" }, "zone": { "description": "[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.", "type": "string" }, "clientOperationId": { "description": "[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.", "type": "string" }, "operationType": { "description": "[Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.", "type": "string" }, "targetLink": { "description": "[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.", "type": "string" }, "targetId": { "description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.", "type": "string", "format": "uint64" }, "status": { "description": "[Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "DONE", "PENDING", "RUNNING" ] }, "statusMessage": { "description": "[Output Only] An optional textual description of the current status of the operation.", "type": "string" }, "user": { "description": "[Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global\/workforcePools\/example-com-us-employees)`.", "type": "string" }, "progress": { "description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.", "type": "integer", "format": "int32" }, "insertTime": { "description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format.", "type": "string" }, "startTime": { "description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.", "type": "string" }, "endTime": { "description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format.", "type": "string" }, "error": { "description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.", "type": "object", "properties": { "errors": { "description": "[Output Only] The array of errors encountered while processing this operation.", "type": "array", "items": { "type": "object", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", "type": "string" }, "location": { "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", "type": "string" }, "message": { "description": "[Output Only] An optional, human-readable error message.", "type": "string" }, "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", "type": "array", "items": { "type": "object", "properties": { "errorInfo": { "$ref": "ErrorInfo" }, "quotaInfo": { "$ref": "QuotaExceededInfo" }, "help": { "$ref": "Help" }, "localizedMessage": { "$ref": "LocalizedMessage" } } } } } } } } }, "warnings": { "description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.", "type": "array", "items": { "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } }, "httpErrorStatusCode": { "description": "[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.", "type": "integer", "format": "int32" }, "httpErrorMessage": { "description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "region": { "description": "[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.", "type": "string" }, "description": { "description": "[Output Only] A textual description of the operation, which is set when the operation is created.", "type": "string" }, "operationGroupId": { "description": "[Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.", "type": "string" } } }, "SetCommonInstanceMetadataOperationMetadata": { "id": "SetCommonInstanceMetadataOperationMetadata", "type": "object", "properties": { "clientOperationId": { "description": "[Output Only] The client operation id.", "type": "string" }, "perLocationOperations": { "description": "[Output Only] Status information per location (location name is key). Example key: zones\/us-central1-a", "type": "object", "additionalProperties": { "$ref": "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo" } } } }, "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo": { "id": "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo", "type": "object", "properties": { "state": { "description": "[Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.", "type": "string", "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.", "" ], "enum": [ "ABANDONED", "DONE", "FAILED", "PROPAGATED", "PROPAGATING", "UNSPECIFIED" ] }, "error": { "description": "[Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.", "$ref": "Status" } } }, "Status": { "id": "Status", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https:\/\/github.com\/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https:\/\/cloud.google.com\/apis\/design\/errors).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "format": "google.protobuf.Any", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "InstancesBulkInsertOperationMetadata": { "id": "InstancesBulkInsertOperationMetadata", "type": "object", "properties": { "perLocationStatus": { "description": "Status information per location (location name is key). Example key: zones\/us-central1-a", "type": "object", "additionalProperties": { "$ref": "BulkInsertOperationStatus" } } } }, "BulkInsertOperationStatus": { "id": "BulkInsertOperationStatus", "type": "object", "properties": { "status": { "description": "[Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.", "type": "string", "enumDescriptions": [ "Rolling forward - creating VMs.", "Done", "Rolling back - cleaning up after an error.", "" ], "enum": [ "CREATING", "DONE", "ROLLING_BACK", "STATUS_UNSPECIFIED" ] }, "targetVmCount": { "description": "[Output Only] Count of VMs originally planned to be created.", "type": "integer", "format": "int32" }, "createdVmCount": { "description": "[Output Only] Count of VMs successfully created so far.", "type": "integer", "format": "int32" }, "failedToCreateVmCount": { "description": "[Output Only] Count of VMs that started creating but encountered an error.", "type": "integer", "format": "int32" }, "deletedVmCount": { "description": "[Output Only] Count of VMs that got deleted during rollback.", "type": "integer", "format": "int32" } } }, "ErrorInfo": { "id": "ErrorInfo", "description": "Describes the cause of the error with structured details. Example of an error when contacting the \"pubsub.googleapis.com\" API when it is not enabled: { \"reason\": \"API_DISABLED\" \"domain\": \"googleapis.com\" \"metadata\": { \"resource\": \"projects\/123\", \"service\": \"pubsub.googleapis.com\" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { \"reason\": \"STOCKOUT\" \"domain\": \"spanner.googleapis.com\", \"metadata\": { \"availableRegions\": \"us-central1,us-east2\" } }", "type": "object", "properties": { "reason": { "description": "The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", "type": "string" }, "domain": { "description": "The logical grouping to which the \"reason\" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: \"pubsub.googleapis.com\". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is \"googleapis.com\".", "type": "string" }, "metadatas": { "description": "Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{\"instanceLimit\": \"100\/request\"}`, should be returned as, `{\"instanceLimitPerRequest\": \"100\"}`, if the client exceeds the number of instances that can be created in a single (batch) request.", "type": "object", "additionalProperties": { "type": "string" } } } }, "QuotaExceededInfo": { "id": "QuotaExceededInfo", "description": "Additional details for quota exceeded error for resource quota.", "type": "object", "properties": { "metricName": { "description": "The Compute Engine quota metric name.", "type": "string" }, "limitName": { "description": "The name of the quota limit.", "type": "string" }, "dimensions": { "description": "The map holding related quota dimensions.", "type": "object", "additionalProperties": { "type": "string" } }, "limit": { "description": "Current effective quota limit. The limit's unit depends on the quota type or metric.", "type": "number", "format": "double" }, "futureLimit": { "description": "Future quota limit being rolled out. The limit's unit depends on the quota type or metric.", "type": "number", "format": "double" }, "rolloutStatus": { "description": "Rollout status of the future quota limit.", "type": "string", "enumDescriptions": [ "IN_PROGRESS - A rollout is in process which will change the limit value to future limit.", "ROLLOUT_STATUS_UNSPECIFIED - Rollout status is not specified. The default value." ], "enum": [ "IN_PROGRESS", "ROLLOUT_STATUS_UNSPECIFIED" ] } } }, "Help": { "id": "Help", "description": "Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.", "type": "object", "properties": { "links": { "description": "URL(s) pointing to additional information on handling the current error.", "type": "array", "items": { "$ref": "HelpLink" } } } }, "HelpLink": { "id": "HelpLink", "description": "Describes a URL link.", "type": "object", "properties": { "description": { "description": "Describes what the link offers.", "type": "string" }, "url": { "description": "The URL of the link.", "type": "string" } } }, "LocalizedMessage": { "id": "LocalizedMessage", "description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error.", "type": "object", "properties": { "locale": { "description": "The locale used following the specification defined at https:\/\/www.rfc-editor.org\/rfc\/bcp\/bcp47.txt. Examples are: \"en-US\", \"fr-CH\", \"es-MX\"", "type": "string" }, "message": { "description": "The localized error message in the above locale.", "type": "string" } } }, "OperationAggregatedList": { "id": "OperationAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always `compute#operationAggregatedList` for aggregated lists of operations.", "default": "compute#operationAggregatedList", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string" }, "items": { "description": "[Output Only] A map of scoped operation lists.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of operations.", "$ref": "OperationsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than `maxResults`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "OperationsScopedList": { "id": "OperationsScopedList", "type": "object", "properties": { "operations": { "description": "[Output Only] A list of operations contained in this scope.", "type": "array", "items": { "$ref": "Operation" } }, "warning": { "description": "[Output Only] Informational warning which replaces the list of operations when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "AcceleratorTypeList": { "id": "AcceleratorTypeList", "description": "Contains a list of accelerator types.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types.", "default": "compute#acceleratorTypeList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of AcceleratorType resources.", "type": "array", "items": { "$ref": "AcceleratorType" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "AcceleratorType": { "id": "AcceleratorType", "description": "Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine.", "type": "object", "properties": { "kind": { "description": "[Output Only] The type of the resource. Always compute#acceleratorType for accelerator types.", "default": "compute#acceleratorType", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "[Output Only] Name of the resource.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "[Output Only] An optional textual description of the resource.", "type": "string" }, "deprecated": { "description": "[Output Only] The deprecation status associated with this accelerator type.", "$ref": "DeprecationStatus" }, "zone": { "description": "[Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined, fully qualified URL for this resource.", "type": "string" }, "maximumCardsPerInstance": { "description": "[Output Only] Maximum number of accelerator cards allowed per instance.", "type": "integer", "format": "int32" } } }, "DeprecationStatus": { "id": "DeprecationStatus", "description": "Deprecation status for a public resource.", "type": "object", "properties": { "state": { "description": "The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.", "type": "string", "enumDescriptions": [ "", "", "", "" ], "enum": [ "ACTIVE", "DELETED", "DEPRECATED", "OBSOLETE" ] }, "replacement": { "description": "The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.", "type": "string" }, "deprecated": { "description": "An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.", "type": "string" }, "obsolete": { "description": "An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.", "type": "string" }, "deleted": { "description": "An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.", "type": "string" } } }, "AcceleratorTypeAggregatedList": { "id": "AcceleratorTypeAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types.", "default": "compute#acceleratorTypeAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of AcceleratorTypesScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of accelerator types.", "$ref": "AcceleratorTypesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "AcceleratorTypesScopedList": { "id": "AcceleratorTypesScopedList", "type": "object", "properties": { "acceleratorTypes": { "description": "[Output Only] A list of accelerator types contained in this scope.", "type": "array", "items": { "$ref": "AcceleratorType" } }, "warning": { "description": "[Output Only] An informational warning that appears when the accelerator types list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "AddressList": { "id": "AddressList", "description": "Contains a list of addresses.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#addressList for lists of addresses.", "default": "compute#addressList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Address resources.", "type": "array", "items": { "$ref": "Address" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" } } }, "Address": { "id": "Address", "description": "Represents an IP Address resource. Google Compute Engine has two IP Address resources: * [Global (external and internal)](https:\/\/cloud.google.com\/compute\/docs\/reference\/rest\/v2\/globalAddresses) * [Regional (external and internal)](https:\/\/cloud.google.com\/compute\/docs\/reference\/rest\/v2\/addresses) For more information, see Reserving a static external IP address.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#address for addresses.", "default": "compute#address", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.addresses.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this field when you create the resource.", "type": "string" }, "address": { "description": "The static IP address represented by this resource.", "type": "string" }, "prefixLength": { "description": "The prefix length if the resource represents an IP range.", "type": "integer", "format": "int32" }, "status": { "description": "[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.", "type": "string", "enumDescriptions": [ "Address is being used by another resource and is not available.", "Address is reserved and available to use.", "Address is being reserved." ], "enum": [ "IN_USE", "RESERVED", "RESERVING" ] }, "region": { "description": "[Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "users": { "description": "[Output Only] The URLs of the resources that are using this address.", "type": "array", "items": { "type": "string" } }, "networkTier": { "description": "This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM.", "type": "string", "enumDescriptions": [ "Public internet quality with fixed bandwidth.", "High quality, Google-grade network tier, support for all networking products.", "Public internet quality, only limited support for other networking products.", "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured." ], "enum": [ "FIXED_STANDARD", "PREMIUM", "STANDARD", "STANDARD_OVERRIDES_FIXED_STANDARD" ] }, "labels": { "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key\/value pair must comply with RFC1035. Label values may be empty.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address.", "type": "string", "format": "byte" }, "ipVersion": { "description": "The IP version that will be used by this address. Valid options are IPV4 or IPV6.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "IPV4", "IPV6", "UNSPECIFIED_VERSION" ] }, "addressType": { "description": "The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.", "type": "string", "enumDescriptions": [ "A publicly visible external IP address.", "A private network IP address, for use with an Instance or Internal Load Balancer forwarding rule.", "" ], "enum": [ "EXTERNAL", "INTERNAL", "UNSPECIFIED_TYPE" ] }, "purpose": { "description": "The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. ", "type": "string", "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 that is used in HA VPN over Cloud Interconnect. This regional internal IP address range must not overlap with any IP address range of subnet\/route in the VPC network and its peering networks. After the VLAN attachment is created with the reserved IP address range, when creating a new VPN gateway, its interface IP address is allocated from 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 Service Connect. This purpose can be specified only for GLOBAL 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 Load Balancer forwarding rules.", "IP range for peer networks." ], "enum": [ "DNS_RESOLVER", "GCE_ENDPOINT", "IPSEC_INTERCONNECT", "NAT_AUTO", "PRIVATE_SERVICE_CONNECT", "SERVERLESS", "SHARED_LOADBALANCER_VIP", "VPC_PEERING" ] }, "subnetwork": { "description": "The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.", "type": "string" }, "network": { "description": "The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.", "type": "string" }, "ipv6EndpointType": { "description": "The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.", "type": "string", "enumDescriptions": [ "Reserved IPv6 address can be used on network load balancer.", "Reserved IPv6 address can be used on VM." ], "enum": [ "NETLB", "VM" ] } } }, "GlobalAddressesMoveRequest": { "id": "GlobalAddressesMoveRequest", "type": "object", "properties": { "destinationAddress": { "description": "The URL of the destination address to move to. This can be a full or partial URL. For example, the following are all valid URLs to a address: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project \/global\/addresses\/address - projects\/project\/global\/addresses\/address Note that destination project must be different from the source project. So \/global\/addresses\/address is not valid partial url.", "type": "string" }, "description": { "description": "An optional destination address description if intended to be different from the source.", "type": "string" } } }, "GlobalSetLabelsRequest": { "id": "GlobalSetLabelsRequest", "type": "object", "properties": { "labels": { "description": "A list of labels to apply for this resource. Each label must comply with the requirements for labels. For example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\").", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint.", "type": "string", "format": "byte" } } }, "AddressAggregatedList": { "id": "AddressAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.", "default": "compute#addressAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of AddressesScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of addresses.", "$ref": "AddressesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "AddressesScopedList": { "id": "AddressesScopedList", "type": "object", "properties": { "addresses": { "description": "[Output Only] A list of addresses contained in this scope.", "type": "array", "items": { "$ref": "Address" } }, "warning": { "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "RegionAddressesMoveRequest": { "id": "RegionAddressesMoveRequest", "type": "object", "properties": { "destinationAddress": { "description": "The URL of the destination address to move to. This can be a full or partial URL. For example, the following are all valid URLs to a address: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/regions\/region \/addresses\/address - projects\/project\/regions\/region\/addresses\/address Note that destination project must be different from the source project. So \/regions\/region\/addresses\/address is not valid partial url.", "type": "string" }, "description": { "description": "An optional destination address description if intended to be different from the source.", "type": "string" } } }, "RegionSetLabelsRequest": { "id": "RegionSetLabelsRequest", "type": "object", "properties": { "labels": { "description": "The labels to set for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.", "type": "string", "format": "byte" } } }, "ImageList": { "id": "ImageList", "description": "Contains a list of images.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#imageList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Image resources.", "type": "array", "items": { "$ref": "Image" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Image": { "id": "Image", "description": "Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#image for images.", "default": "compute#image", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.images.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "sourceType": { "description": "The type of the image used to create this disk. The default and only valid value is RAW.", "default": "RAW", "type": "string", "enumDescriptions": [ "" ], "enum": [ "RAW" ] }, "rawDisk": { "description": "The parameters of the raw disk image.", "type": "object", "properties": { "source": { "description": "The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https:\/\/storage.googleapis.com\/bucket_name\/image_archive_name - https:\/\/storage.googleapis.com\/bucket_name\/folder_name\/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", "type": "string" }, "sha1Checksum": { "description": "[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.", "pattern": "[a-f0-9]{40}", "deprecated": true, "type": "string" }, "containerType": { "description": "The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.", "type": "string", "enumDescriptions": [ "" ], "enum": [ "TAR" ] } } }, "deprecated": { "description": "The deprecation status associated with this image.", "$ref": "DeprecationStatus" }, "status": { "description": "[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.", "type": "string", "enumDescriptions": [ "Image is deleting.", "Image creation failed due to an error.", "Image hasn't been created as yet.", "Image has been successfully created." ], "enum": [ "DELETING", "FAILED", "PENDING", "READY" ] }, "archiveSizeBytes": { "description": "Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).", "type": "string", "format": "int64" }, "diskSizeGb": { "description": "Size of the image when restored onto a persistent disk (in GB).", "type": "string", "format": "int64" }, "sourceDisk": { "description": "URL of the source disk used to create this image. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/disks\/disk - projects\/project\/zones\/zone\/disks\/disk - zones\/zone\/disks\/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", "type": "string" }, "sourceDiskId": { "description": "[Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.", "type": "string" }, "licenses": { "description": "Any applicable license URI.", "type": "array", "items": { "type": "string" } }, "family": { "description": "The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.", "type": "string" }, "imageEncryptionKey": { "description": "Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.", "$ref": "CustomerEncryptionKey" }, "sourceDiskEncryptionKey": { "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.", "$ref": "CustomerEncryptionKey" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "labels": { "description": "Labels to apply to this image. These can be later modified by the setLabels method.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image.", "type": "string", "format": "byte" }, "guestOsFeatures": { "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter.", "type": "array", "items": { "$ref": "GuestOsFeature" } }, "licenseCodes": { "description": "Integer license codes indicating which licenses are attached to this image.", "type": "array", "items": { "type": "string", "format": "int64" } }, "sourceImage": { "description": "URL of the source image used to create this image. The following are valid formats for the URL: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project_id\/global\/ images\/image_name - projects\/project_id\/global\/images\/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", "type": "string" }, "sourceImageId": { "description": "[Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.", "type": "string" }, "sourceImageEncryptionKey": { "description": "The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.", "$ref": "CustomerEncryptionKey" }, "sourceSnapshot": { "description": "URL of the source snapshot used to create this image. The following are valid formats for the URL: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project_id\/global\/ snapshots\/snapshot_name - projects\/project_id\/global\/snapshots\/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL ", "type": "string" }, "sourceSnapshotId": { "description": "[Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.", "type": "string" }, "sourceSnapshotEncryptionKey": { "description": "The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.", "$ref": "CustomerEncryptionKey" }, "storageLocations": { "description": "Cloud Storage bucket storage location of the image (regional or multi-regional).", "type": "array", "items": { "type": "string" } }, "shieldedInstanceInitialState": { "description": "Set the secure boot keys of shielded instance.", "$ref": "InitialStateConfig" }, "satisfiesPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "architecture": { "description": "The architecture of the image. Valid values are ARM64 or X86_64.", "type": "string", "enumDescriptions": [ "Default value indicating Architecture is not set.", "Machines with architecture ARM64", "Machines with architecture X86_64" ], "enum": [ "ARCHITECTURE_UNSPECIFIED", "ARM64", "X86_64" ] }, "enableConfidentialCompute": { "description": "Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.", "type": "boolean" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" } } }, "CustomerEncryptionKey": { "id": "CustomerEncryptionKey", "type": "object", "properties": { "rawKey": { "description": "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: \"rawKey\": \"SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=\" ", "type": "string" }, "rsaEncryptedKey": { "description": "Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: \"rsaEncryptedKey\": \"ieCx\/NcW06PcT7Ep1X6LUTc\/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC\/jEk014kCK\/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==\" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https:\/\/cloud-certs.storage.googleapis.com\/google-cloud-csek-ingress.pem ", "type": "string" }, "kmsKeyName": { "description": "The name of the encryption key that is stored in Google Cloud KMS. For example: \"kmsKeyName\": \"projects\/kms_project_id\/locations\/region\/keyRings\/ key_region\/cryptoKeys\/key The fully-qualifed key name may be returned for resource GET requests. For example: \"kmsKeyName\": \"projects\/kms_project_id\/locations\/region\/keyRings\/ key_region\/cryptoKeys\/key \/cryptoKeyVersions\/1 ", "type": "string" }, "sha256": { "description": "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.", "type": "string" }, "kmsKeyServiceAccount": { "description": "The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: \"kmsKeyServiceAccount\": \"name@project_id.iam.gserviceaccount.com\/ ", "type": "string" } } }, "GuestOsFeature": { "id": "GuestOsFeature", "description": "Guest OS features.", "type": "object", "properties": { "type": { "description": "The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF For more information, see Enabling guest operating system features.", "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "" ], "enum": [ "FEATURE_TYPE_UNSPECIFIED", "GVNIC", "IDPF", "MULTI_IP_SUBNET", "SECURE_BOOT", "SEV_CAPABLE", "SEV_LIVE_MIGRATABLE", "SEV_LIVE_MIGRATABLE_V2", "SEV_SNP_CAPABLE", "TDX_CAPABLE", "UEFI_COMPATIBLE", "VIRTIO_SCSI_MULTIQUEUE", "WINDOWS" ] } } }, "InitialStateConfig": { "id": "InitialStateConfig", "description": "Initial State for shielded instance, these are public keys which are safe to store in public", "type": "object", "properties": { "pk": { "description": "The Platform Key (PK).", "$ref": "FileContentBuffer" }, "keks": { "description": "The Key Exchange Key (KEK).", "type": "array", "items": { "$ref": "FileContentBuffer" } }, "dbs": { "description": "The Key Database (db).", "type": "array", "items": { "$ref": "FileContentBuffer" } }, "dbxs": { "description": "The forbidden key database (dbx).", "type": "array", "items": { "$ref": "FileContentBuffer" } } } }, "FileContentBuffer": { "id": "FileContentBuffer", "type": "object", "properties": { "content": { "description": "The raw content in the secure keys file.", "type": "string", "format": "byte" }, "fileType": { "description": "The file type of source file.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "BIN", "UNDEFINED", "X509" ] } } }, "Policy": { "id": "Policy", "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https:\/\/cloud.google.com\/iam\/help\/conditions\/resource-policies). JSON example:* ``` { \"bindings\": [ { \"role\": \"roles\/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles\/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` YAML example: ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles\/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles\/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https:\/\/cloud.google.com\/iam\/docs\/).", "type": "object", "properties": { "version": { "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https:\/\/cloud.google.com\/iam\/help\/conditions\/resource-policies).", "type": "integer", "format": "int32" }, "bindings": { "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "type": "array", "items": { "$ref": "Binding" } }, "auditConfigs": { "description": "Specifies cloud audit logging configuration for this policy.", "type": "array", "items": { "$ref": "AuditConfig" } }, "etag": { "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "type": "string", "format": "byte" } } }, "Binding": { "id": "Binding", "description": "Associates `members`, or principals, with a `role`.", "type": "object", "properties": { "role": { "description": "Role that is assigned to the list of `members`, or principals. For example, `roles\/viewer`, `roles\/editor`, or `roles\/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https:\/\/cloud.google.com\/iam\/docs\/roles-overview). For a list of the available pre-defined roles, see [here](https:\/\/cloud.google.com\/iam\/docs\/understanding-roles).", "type": "string" }, "members": { "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}\/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https:\/\/cloud.google.com\/kubernetes-engine\/docs\/how-to\/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace\/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal:\/\/iam.googleapis.com\/locations\/global\/workforcePools\/{pool_id}\/subject\/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet:\/\/iam.googleapis.com\/locations\/global\/workforcePools\/{pool_id}\/group\/{group_id}`: All workforce identities in a group. * `principalSet:\/\/iam.googleapis.com\/locations\/global\/workforcePools\/{pool_id}\/attribute.{attribute_name}\/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet:\/\/iam.googleapis.com\/locations\/global\/workforcePools\/{pool_id}\/`: All identities in a workforce identity pool. `principal:\/\/iam.googleapis.com\/projects\/{project_number}\/locations\/global\/workloadIdentityPools\/{pool_id}\/subject\/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet:\/\/iam.googleapis.com\/projects\/{project_number}\/locations\/global\/workloadIdentityPools\/{pool_id}\/group\/{group_id}`: A workload identity pool group. * `principalSet:\/\/iam.googleapis.com\/projects\/{project_number}\/locations\/global\/workloadIdentityPools\/{pool_id}\/attribute.{attribute_name}\/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet:\/\/iam.googleapis.com\/projects\/{project_number}\/locations\/global\/workloadIdentityPools\/{pool_id}\/`: All identities in a workload identity pool. `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal:\/\/iam.googleapis.com\/locations\/global\/workforcePools\/{pool_id}\/subject\/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal:\/\/iam.googleapis.com\/locations\/global\/workforcePools\/my-pool-id\/subject\/my-subject-attribute-value`.", "type": "array", "items": { "type": "string" } }, "condition": { "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https:\/\/cloud.google.com\/iam\/help\/conditions\/resource-policies).", "$ref": "Expr" } } }, "Expr": { "id": "Expr", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https:\/\/github.com\/google\/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "type": "object", "properties": { "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" } } }, "AuditConfig": { "id": "AuditConfig", "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "type": "object", "properties": { "service": { "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", "type": "string" }, "auditLogConfigs": { "description": "The configuration for logging of each type of permission.", "type": "array", "items": { "$ref": "AuditLogConfig" } } } }, "AuditLogConfig": { "id": "AuditLogConfig", "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "type": "object", "properties": { "logType": { "description": "The log type that this config enables.", "type": "string", "enumDescriptions": [ "Admin reads. Example: CloudIAM getIamPolicy", "Data reads. Example: CloudSQL Users list", "Data writes. Example: CloudSQL Users create", "Default case. Should never be this." ], "enum": [ "ADMIN_READ", "DATA_READ", "DATA_WRITE", "LOG_TYPE_UNSPECIFIED" ] }, "exemptedMembers": { "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "type": "array", "items": { "type": "string" } } } }, "GlobalSetPolicyRequest": { "id": "GlobalSetPolicyRequest", "type": "object", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.", "$ref": "Policy" }, "bindings": { "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.", "type": "array", "items": { "$ref": "Binding" } }, "etag": { "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", "type": "string", "format": "byte" } } }, "TestPermissionsRequest": { "id": "TestPermissionsRequest", "type": "object", "properties": { "permissions": { "description": "The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.", "type": "array", "items": { "type": "string" } } } }, "TestPermissionsResponse": { "id": "TestPermissionsResponse", "type": "object", "properties": { "permissions": { "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "type": "array", "items": { "type": "string" } } } }, "ImageFamilyView": { "id": "ImageFamilyView", "type": "object", "properties": { "image": { "description": "The latest image that is part of the specified image family in the requested location, and that is not deprecated.", "$ref": "Image" } } }, "SnapshotList": { "id": "SnapshotList", "description": "Contains a list of Snapshot resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#snapshotList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Snapshot resources.", "type": "array", "items": { "$ref": "Snapshot" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Snapshot": { "id": "Snapshot", "description": "Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.", "default": "compute#snapshot", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.disks.createSnapshot", "compute.snapshots.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "status": { "description": "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.", "type": "string", "enumDescriptions": [ "Snapshot creation is in progress.", "Snapshot is currently being deleted.", "Snapshot creation failed.", "Snapshot has been created successfully.", "Snapshot is being uploaded." ], "enum": [ "CREATING", "DELETING", "FAILED", "READY", "UPLOADING" ] }, "sourceDisk": { "description": "The source disk used to create this snapshot.", "type": "string" }, "sourceDiskId": { "description": "[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.", "type": "string" }, "diskSizeGb": { "description": "[Output Only] Size of the source disk, specified in GB.", "type": "string", "format": "int64" }, "storageBytes": { "description": "[Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation\/deletion.", "type": "string", "format": "int64" }, "storageBytesStatus": { "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "UPDATING", "UP_TO_DATE" ] }, "licenses": { "description": "[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).", "type": "array", "items": { "type": "string" } }, "snapshotEncryptionKey": { "description": "Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.", "$ref": "CustomerEncryptionKey" }, "sourceDiskEncryptionKey": { "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.", "$ref": "CustomerEncryptionKey" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "labels": { "description": "Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot.", "type": "string", "format": "byte" }, "licenseCodes": { "description": "[Output Only] Integer license codes indicating which licenses are attached to this snapshot.", "type": "array", "items": { "type": "string", "format": "int64" } }, "storageLocations": { "description": "Cloud Storage bucket storage location of the snapshot (regional or multi-regional).", "type": "array", "items": { "type": "string" } }, "autoCreated": { "description": "[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.", "type": "boolean" }, "guestOsFeatures": { "description": "[Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.", "type": "array", "items": { "$ref": "GuestOsFeature" } }, "downloadBytes": { "description": "[Output Only] Number of bytes downloaded to restore a snapshot to a disk.", "type": "string", "format": "int64" }, "chainName": { "description": "Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value.", "type": "string" }, "satisfiesPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "locationHint": { "description": "An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API.", "type": "string" }, "sourceSnapshotSchedulePolicy": { "description": "[Output Only] URL of the resource policy which created this scheduled snapshot.", "type": "string" }, "sourceSnapshotSchedulePolicyId": { "description": "[Output Only] ID of the resource policy which created this scheduled snapshot.", "type": "string" }, "sourceInstantSnapshot": { "description": "The source instant snapshot used to create this snapshot. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/instantSnapshots\/instantSnapshot - projects\/project\/zones\/zone\/instantSnapshots\/instantSnapshot - zones\/zone\/instantSnapshots\/instantSnapshot ", "type": "string" }, "sourceInstantSnapshotId": { "description": "[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this snapshot. For example, if you created the snapshot from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used.", "type": "string" }, "architecture": { "description": "[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.", "type": "string", "enumDescriptions": [ "Default value indicating Architecture is not set.", "Machines with architecture ARM64", "Machines with architecture X86_64" ], "enum": [ "ARCHITECTURE_UNSPECIFIED", "ARM64", "X86_64" ] }, "snapshotType": { "description": "Indicates the type of the snapshot.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "ARCHIVE", "STANDARD" ] }, "creationSizeBytes": { "description": "[Output Only] Size in bytes of the snapshot at creation time.", "type": "string", "format": "int64" }, "enableConfidentialCompute": { "description": "Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.", "type": "boolean" }, "sourceDiskForRecoveryCheckpoint": { "description": "The source disk whose recovery checkpoint will be used to create this snapshot.", "type": "string" }, "sourceInstantSnapshotEncryptionKey": { "description": "Customer provided encryption key when creating Snapshot from Instant Snapshot.", "$ref": "CustomerEncryptionKey" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" } } }, "DiskList": { "id": "DiskList", "description": "A list of Disk resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#diskList for lists of disks.", "default": "compute#diskList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Disk resources.", "type": "array", "items": { "$ref": "Disk" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Disk": { "id": "Disk", "description": "Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: [Zonal](\/compute\/docs\/reference\/rest\/v2\/disks) * [Regional](\/compute\/docs\/reference\/rest\/v2\/regionDisks) Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#disk for disks.", "default": "compute#disk", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.disks.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "sizeGb": { "description": "Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are greater than 0.", "type": "string", "format": "int64" }, "zone": { "description": "[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "status": { "description": "[Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. ", "type": "string", "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 detached." ], "enum": [ "CREATING", "DELETING", "FAILED", "READY", "RESTORING", "UNAVAILABLE" ] }, "sourceSnapshot": { "description": "The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project \/global\/snapshots\/snapshot - projects\/project\/global\/snapshots\/snapshot - global\/snapshots\/snapshot ", "type": "string" }, "sourceSnapshotId": { "description": "[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.", "type": "string" }, "sourceStorageObject": { "description": "The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:\/\/ or https:\/\/storage.googleapis.com\/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.", "type": "string" }, "options": { "description": "Internal use only.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" }, "sourceImage": { "description": "The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family\/debian-9 to use the latest Debian 9 image: projects\/debian-cloud\/global\/images\/family\/debian-9 Alternatively, use a specific version of a public operating system image: projects\/debian-cloud\/global\/images\/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global\/images\/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family\/family-name: global\/images\/family\/my-image-family ", "type": "string" }, "sourceImageId": { "description": "[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.", "type": "string" }, "type": { "description": "URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects\/project \/zones\/zone\/diskTypes\/pd-ssd . See Persistent disk types.", "type": "string" }, "licenses": { "description": "A list of publicly visible licenses. Reserved for Google's use.", "type": "array", "items": { "type": "string" } }, "guestOsFeatures": { "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.", "type": "array", "items": { "$ref": "GuestOsFeature" } }, "lastAttachTimestamp": { "description": "[Output Only] Last attach timestamp in RFC3339 text format.", "type": "string" }, "lastDetachTimestamp": { "description": "[Output Only] Last detach timestamp in RFC3339 text format.", "type": "string" }, "users": { "description": "[Output Only] Links to the users of the disk (attached instances) in form: projects\/project\/zones\/zone\/instances\/instance", "type": "array", "items": { "type": "string" } }, "diskEncryptionKey": { "description": "Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version* name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: \"diskEncryptionKey.kmsKeyName\": \"projects\/kms_project_id\/locations\/region\/keyRings\/ key_region\/cryptoKeys\/key \/cryptoKeysVersions\/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.", "$ref": "CustomerEncryptionKey" }, "sourceImageEncryptionKey": { "description": "The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.", "$ref": "CustomerEncryptionKey" }, "sourceSnapshotEncryptionKey": { "description": "The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.", "$ref": "CustomerEncryptionKey" }, "labels": { "description": "Labels to apply to this disk. These can be later modified by the setLabels method.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.", "type": "string", "format": "byte" }, "region": { "description": "[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "replicaZones": { "description": "URLs of the zones where the disk should be replicated to. Only applicable for regional resources.", "type": "array", "items": { "type": "string" } }, "licenseCodes": { "description": "Integer license codes indicating which licenses are attached to this disk.", "type": "array", "items": { "type": "string", "format": "int64" } }, "physicalBlockSizeBytes": { "description": "Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.", "type": "string", "format": "int64" }, "resourcePolicies": { "description": "Resource policies applied to this disk for automatic snapshot creations.", "type": "array", "items": { "type": "string" } }, "sourceDisk": { "description": "The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/disks\/disk - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/regions\/region \/disks\/disk - projects\/project\/zones\/zone\/disks\/disk - projects\/project\/regions\/region\/disks\/disk - zones\/zone\/disks\/disk - regions\/region\/disks\/disk ", "type": "string" }, "sourceDiskId": { "description": "[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.", "type": "string" }, "provisionedIops": { "description": "Indicates how many IOPS to provision for the disk. This sets the number of I\/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.", "type": "string", "format": "int64" }, "provisionedThroughput": { "description": "Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1.", "type": "string", "format": "int64" }, "enableConfidentialCompute": { "description": "Whether this disk is using confidential compute mode.", "type": "boolean" }, "sourceInstantSnapshot": { "description": "The source instant snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/instantSnapshots\/instantSnapshot - projects\/project\/zones\/zone\/instantSnapshots\/instantSnapshot - zones\/zone\/instantSnapshots\/instantSnapshot ", "type": "string" }, "sourceInstantSnapshotId": { "description": "[Output Only] The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.", "type": "string" }, "satisfiesPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "locationHint": { "description": "An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.", "type": "string" }, "storagePool": { "description": "The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/storagePools\/storagePool - projects\/project\/zones\/zone\/storagePools\/storagePool - zones\/zone\/storagePools\/storagePool ", "type": "string" }, "accessMode": { "description": "The access mode of the disk. - READ_WRITE_SINGLE: The default AccessMode, means the disk can be attached to single instance in RW mode. - READ_WRITE_MANY: The AccessMode means the disk can be attached to multiple instances in RW mode. - READ_ONLY_MANY: The AccessMode means the disk can be attached to multiple instances in RO mode. The AccessMode is only valid for Hyperdisk disk types.", "type": "string", "enumDescriptions": [ "The AccessMode means the disk can be attached to multiple instances in RO mode.", "The AccessMode means the disk can be attached to multiple instances in RW mode.", "The default AccessMode, means the disk can be attached to single instance in RW mode." ], "enum": [ "READ_ONLY_MANY", "READ_WRITE_MANY", "READ_WRITE_SINGLE" ] }, "asyncPrimaryDisk": { "description": "Disk asynchronously replicated into this disk.", "$ref": "DiskAsyncReplication" }, "asyncSecondaryDisks": { "description": "[Output Only] A list of disks this disk is asynchronously replicated to.", "type": "object", "additionalProperties": { "$ref": "DiskAsyncReplicationList" } }, "resourceStatus": { "description": "[Output Only] Status information for the disk resource.", "$ref": "DiskResourceStatus" }, "sourceConsistencyGroupPolicy": { "description": "[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.", "type": "string" }, "sourceConsistencyGroupPolicyId": { "description": "[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.", "type": "string" }, "architecture": { "description": "The architecture of the disk. Valid values are ARM64 or X86_64.", "type": "string", "enumDescriptions": [ "Default value indicating Architecture is not set.", "Machines with architecture ARM64", "Machines with architecture X86_64" ], "enum": [ "ARCHITECTURE_UNSPECIFIED", "ARM64", "X86_64" ] }, "params": { "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.", "$ref": "DiskParams" } } }, "DiskAsyncReplication": { "id": "DiskAsyncReplication", "type": "object", "properties": { "disk": { "description": "The other disk asynchronously replicated to or from the current disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/disks\/disk - projects\/project\/zones\/zone\/disks\/disk - zones\/zone\/disks\/disk ", "type": "string" }, "diskId": { "description": "[Output Only] The unique ID of the other disk asynchronously replicated to or from the current disk. This value identifies the exact disk that was used to create this replication. For example, if you started replicating the persistent disk from a disk that was later deleted and recreated under the same name, the disk ID would identify the exact version of the disk that was used.", "type": "string" }, "consistencyGroupPolicy": { "description": "[Output Only] URL of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group.", "type": "string" }, "consistencyGroupPolicyId": { "description": "[Output Only] ID of the DiskConsistencyGroupPolicy if replication was started on the disk as a member of a group.", "type": "string" } } }, "DiskAsyncReplicationList": { "id": "DiskAsyncReplicationList", "type": "object", "properties": { "asyncReplicationDisk": { "$ref": "DiskAsyncReplication" } } }, "DiskResourceStatus": { "id": "DiskResourceStatus", "type": "object", "properties": { "asyncPrimaryDisk": { "$ref": "DiskResourceStatusAsyncReplicationStatus" }, "asyncSecondaryDisks": { "description": "Key: disk, value: AsyncReplicationStatus message", "type": "object", "additionalProperties": { "$ref": "DiskResourceStatusAsyncReplicationStatus" } } } }, "DiskResourceStatusAsyncReplicationStatus": { "id": "DiskResourceStatusAsyncReplicationStatus", "type": "object", "properties": { "state": { "type": "string", "enumDescriptions": [ "Replication is active.", "Secondary disk is created and is waiting for replication to start.", "Replication is starting.", "", "Replication is stopped.", "Replication is stopping." ], "enum": [ "ACTIVE", "CREATED", "STARTING", "STATE_UNSPECIFIED", "STOPPED", "STOPPING" ] } } }, "DiskParams": { "id": "DiskParams", "description": "Additional disk params.", "type": "object", "properties": { "resourceManagerTags": { "description": "Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys\/{tag_key_id}`, and values are in the format `tagValues\/456`. The field is ignored (both PUT & PATCH) when empty.", "type": "object", "additionalProperties": { "type": "string" } } } }, "DiskAggregatedList": { "id": "DiskAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.", "default": "compute#diskAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of DisksScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of disks.", "$ref": "DisksScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "DisksScopedList": { "id": "DisksScopedList", "type": "object", "properties": { "disks": { "description": "[Output Only] A list of disks contained in this scope.", "type": "array", "items": { "$ref": "Disk" } }, "warning": { "description": "[Output Only] Informational warning which replaces the list of disks when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "ZoneSetLabelsRequest": { "id": "ZoneSetLabelsRequest", "type": "object", "properties": { "labels": { "description": "The labels to set for this resource.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.", "type": "string", "format": "byte" } } }, "DisksResizeRequest": { "id": "DisksResizeRequest", "type": "object", "properties": { "sizeGb": { "description": "The new size of the persistent disk, which is specified in GB.", "type": "string", "format": "int64" } } }, "DisksAddResourcePoliciesRequest": { "id": "DisksAddResourcePoliciesRequest", "type": "object", "properties": { "resourcePolicies": { "description": "Full or relative path to the resource policy to be added to this disk. You can only specify one resource policy.", "type": "array", "items": { "type": "string" } } } }, "DisksRemoveResourcePoliciesRequest": { "id": "DisksRemoveResourcePoliciesRequest", "type": "object", "properties": { "resourcePolicies": { "description": "Resource policies to be removed from this disk.", "type": "array", "items": { "type": "string" } } } }, "ZoneSetPolicyRequest": { "id": "ZoneSetPolicyRequest", "type": "object", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.", "$ref": "Policy" }, "bindings": { "description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.", "type": "array", "items": { "$ref": "Binding" } }, "etag": { "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", "type": "string", "format": "byte" } } }, "DisksStartAsyncReplicationRequest": { "id": "DisksStartAsyncReplicationRequest", "type": "object", "properties": { "asyncSecondaryDisk": { "description": "The secondary disk to start asynchronous replication to. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/disks\/disk - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/regions\/region \/disks\/disk - projects\/project\/zones\/zone\/disks\/disk - projects\/project\/regions\/region\/disks\/disk - zones\/zone\/disks\/disk - regions\/region\/disks\/disk ", "type": "string" } } }, "DisksStopGroupAsyncReplicationResource": { "id": "DisksStopGroupAsyncReplicationResource", "description": "A transient resource used in compute.disks.stopGroupAsyncReplication and compute.regionDisks.stopGroupAsyncReplication. It is only used to process requests and is not persisted.", "type": "object", "properties": { "resourcePolicy": { "description": "The URL of the DiskConsistencyGroupPolicy for the group of disks to stop. This may be a full or partial URL, such as: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/regions\/region \/resourcePolicies\/resourcePolicy - projects\/project\/regions\/region\/resourcePolicies\/resourcePolicy - regions\/region\/resourcePolicies\/resourcePolicy ", "type": "string" } } }, "BulkInsertDiskResource": { "id": "BulkInsertDiskResource", "description": "A transient resource used in compute.disks.bulkInsert and compute.regionDisks.bulkInsert. It is only used to process requests and is not persisted.", "type": "object", "properties": { "sourceConsistencyGroupPolicy": { "description": "The URL of the DiskConsistencyGroupPolicy for the group of disks to clone. This may be a full or partial URL, such as: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/regions\/region \/resourcePolicies\/resourcePolicy - projects\/project\/regions\/region\/resourcePolicies\/resourcePolicy - regions\/region\/resourcePolicies\/resourcePolicy ", "type": "string" } } }, "RegionDisksResizeRequest": { "id": "RegionDisksResizeRequest", "type": "object", "properties": { "sizeGb": { "description": "The new size of the regional persistent disk, which is specified in GB.", "type": "string", "format": "int64" } } }, "RegionDisksAddResourcePoliciesRequest": { "id": "RegionDisksAddResourcePoliciesRequest", "type": "object", "properties": { "resourcePolicies": { "description": "Resource policies to be added to this disk.", "type": "array", "items": { "type": "string" } } } }, "RegionDisksRemoveResourcePoliciesRequest": { "id": "RegionDisksRemoveResourcePoliciesRequest", "type": "object", "properties": { "resourcePolicies": { "description": "Resource policies to be removed from this disk.", "type": "array", "items": { "type": "string" } } } }, "RegionSetPolicyRequest": { "id": "RegionSetPolicyRequest", "type": "object", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.", "$ref": "Policy" }, "bindings": { "description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.", "type": "array", "items": { "$ref": "Binding" } }, "etag": { "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", "type": "string", "format": "byte" } } }, "RegionDisksStartAsyncReplicationRequest": { "id": "RegionDisksStartAsyncReplicationRequest", "type": "object", "properties": { "asyncSecondaryDisk": { "description": "The secondary disk to start asynchronous replication to. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/disks\/disk - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/regions\/region \/disks\/disk - projects\/project\/zones\/zone\/disks\/disk - projects\/project\/regions\/region\/disks\/disk - zones\/zone\/disks\/disk - regions\/region\/disks\/disk ", "type": "string" } } }, "FirewallList": { "id": "FirewallList", "description": "Contains a list of firewalls.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#firewallList for lists of firewalls.", "default": "compute#firewallList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Firewall resources.", "type": "array", "items": { "$ref": "Firewall" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Firewall": { "id": "Firewall", "description": "Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#firewall for firewall rules.", "default": "compute#firewall", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.firewalls.insert", "compute.firewalls.patch" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this field when you create the resource.", "type": "string" }, "network": { "description": "URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global\/networks\/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/myproject\/global\/networks\/my-network - projects\/myproject\/global\/networks\/my-network - global\/networks\/default ", "type": "string" }, "priority": { "description": "Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.", "type": "integer", "format": "int32" }, "sourceRanges": { "description": "If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported.", "type": "array", "items": { "type": "string" } }, "destinationRanges": { "description": "If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported.", "type": "array", "items": { "type": "string" } }, "sourceTags": { "description": "If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.", "type": "array", "items": { "type": "string" } }, "targetTags": { "description": "A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.", "type": "array", "items": { "type": "string" } }, "sourceServiceAccounts": { "description": "If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.", "type": "array", "items": { "type": "string" } }, "targetServiceAccounts": { "description": "A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.", "type": "array", "items": { "type": "string" } }, "allowed": { "description": "The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.", "type": "array", "items": { "type": "object", "properties": { "IPProtocol": { "description": "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.", "type": "string" }, "ports": { "description": "An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].", "type": "array", "items": { "type": "string" } } } } }, "denied": { "description": "The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.", "type": "array", "items": { "type": "object", "properties": { "IPProtocol": { "description": "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.", "type": "string" }, "ports": { "description": "An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].", "type": "array", "items": { "type": "string" } } } } }, "direction": { "description": "Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot specify the sourceTags fields.", "type": "string", "enumDescriptions": [ "Indicates that firewall should apply to outgoing traffic.", "Indicates that firewall should apply to incoming traffic." ], "enum": [ "EGRESS", "INGRESS" ] }, "logConfig": { "description": "This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.", "$ref": "FirewallLogConfig" }, "disabled": { "description": "Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.", "type": "boolean" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" } } }, "FirewallLogConfig": { "id": "FirewallLogConfig", "description": "The available logging options for a firewall rule.", "type": "object", "properties": { "enable": { "description": "This field denotes whether to enable logging for a particular firewall rule.", "type": "boolean" }, "metadata": { "description": "This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "EXCLUDE_ALL_METADATA", "INCLUDE_ALL_METADATA" ] } } }, "FirewallPolicyList": { "id": "FirewallPolicyList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#firewallPolicyList for listsof FirewallPolicies", "default": "compute#firewallPolicyList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of FirewallPolicy resources.", "type": "array", "items": { "$ref": "FirewallPolicy" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "FirewallPolicy": { "id": "FirewallPolicy", "description": "Represents a Firewall Policy resource.", "type": "object", "properties": { "kind": { "description": "[Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies", "default": "compute#firewallPolicy", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "rules": { "description": "A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match \"\"). If no rules are provided when creating a firewall policy, a default rule with action \"allow\" will be added.", "type": "array", "items": { "$ref": "FirewallPolicyRule" } }, "packetMirroringRules": { "description": "A list of packet mirroring rules that belong to this policy.", "type": "array", "items": { "$ref": "FirewallPolicyRule" } }, "fingerprint": { "description": "Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.", "type": "string", "format": "byte" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" }, "associations": { "description": "A list of associations that belong to this firewall policy.", "type": "array", "items": { "$ref": "FirewallPolicyAssociation" } }, "ruleTupleCount": { "description": "[Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.", "type": "integer", "format": "int32" }, "shortName": { "description": "User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "displayName": { "description": "Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "deprecated": true, "type": "string" }, "parent": { "description": "[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" } } }, "FirewallPolicyRule": { "id": "FirewallPolicyRule", "description": "Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).", "type": "object", "properties": { "kind": { "description": "[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.", "default": "compute#firewallPolicyRule", "type": "string" }, "ruleName": { "description": "An optional name for the rule. This field is not a unique identifier and can be updated.", "type": "string" }, "description": { "description": "An optional description for this resource.", "type": "string" }, "priority": { "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.", "type": "integer", "format": "int32" }, "match": { "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.", "$ref": "FirewallPolicyRuleMatcher" }, "action": { "description": "The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: \"allow\", \"deny\", \"apply_security_profile_group\" and \"goto_next\". Valid actions for packet mirroring rules are: \"mirror\", \"do_not_mirror\" and \"goto_next\".", "type": "string" }, "securityProfileGroup": { "description": "A fully-qualified URL of a SecurityProfile resource instance. Example: https:\/\/networksecurity.googleapis.com\/v1\/projects\/{project}\/locations\/{location}\/securityProfileGroups\/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.", "type": "string" }, "tlsInspect": { "description": "Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.", "type": "boolean" }, "direction": { "description": "The direction in which this rule applies.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "EGRESS", "INGRESS" ] }, "targetResources": { "description": "A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.", "type": "array", "items": { "type": "string" } }, "enableLogging": { "description": "Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub\/Sub. Note: you cannot enable logging on \"goto_next\" rules.", "type": "boolean" }, "ruleTupleCount": { "description": "[Output Only] Calculation of the complexity of a single firewall policy rule.", "type": "integer", "format": "int32" }, "targetServiceAccounts": { "description": "A list of service accounts indicating the sets of instances that are applied with this rule.", "type": "array", "items": { "type": "string" } }, "targetSecureTags": { "description": "A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.", "type": "array", "items": { "$ref": "FirewallPolicyRuleSecureTag" } }, "disabled": { "description": "Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.", "type": "boolean" } } }, "FirewallPolicyRuleMatcher": { "id": "FirewallPolicyRuleMatcher", "description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.", "type": "object", "properties": { "srcIpRanges": { "description": "CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.", "type": "array", "items": { "type": "string" } }, "destIpRanges": { "description": "CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.", "type": "array", "items": { "type": "string" } }, "layer4Configs": { "description": "Pairs of IP protocols and ports that the rule should match.", "type": "array", "items": { "$ref": "FirewallPolicyRuleMatcherLayer4Config" } }, "srcSecureTags": { "description": "List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.", "type": "array", "items": { "$ref": "FirewallPolicyRuleSecureTag" } }, "destAddressGroups": { "description": "Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.", "type": "array", "items": { "type": "string" } }, "srcAddressGroups": { "description": "Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.", "type": "array", "items": { "type": "string" } }, "srcFqdns": { "description": "Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.", "type": "array", "items": { "type": "string" } }, "destFqdns": { "description": "Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.", "type": "array", "items": { "type": "string" } }, "srcRegionCodes": { "description": "Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex.\"US\" Maximum number of source region codes allowed is 5000.", "type": "array", "items": { "type": "string" } }, "destRegionCodes": { "description": "Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex.\"US\" Maximum number of dest region codes allowed is 5000.", "type": "array", "items": { "type": "string" } }, "destThreatIntelligences": { "description": "Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.", "type": "array", "items": { "type": "string" } }, "srcThreatIntelligences": { "description": "Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.", "type": "array", "items": { "type": "string" } } } }, "FirewallPolicyRuleMatcherLayer4Config": { "id": "FirewallPolicyRuleMatcherLayer4Config", "type": "object", "properties": { "ipProtocol": { "description": "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.", "type": "string" }, "ports": { "description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].", "type": "array", "items": { "type": "string" } } } }, "FirewallPolicyRuleSecureTag": { "id": "FirewallPolicyRuleSecureTag", "type": "object", "properties": { "name": { "description": "Name of the secure tag, created with TagManager's TagValue API.", "pattern": "tagValues\/[0-9]+", "type": "string" }, "state": { "description": "[Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "EFFECTIVE", "INEFFECTIVE" ] } } }, "FirewallPolicyAssociation": { "id": "FirewallPolicyAssociation", "type": "object", "properties": { "name": { "description": "The name for an association.", "type": "string" }, "attachmentTarget": { "description": "The target that the firewall policy is attached to.", "type": "string" }, "firewallPolicyId": { "description": "[Output Only] The firewall policy ID of the association.", "type": "string" }, "shortName": { "description": "[Output Only] The short name of the firewall policy of the association.", "type": "string" }, "displayName": { "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.", "deprecated": true, "type": "string" } } }, "FirewallPoliciesListAssociationsResponse": { "id": "FirewallPoliciesListAssociationsResponse", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of firewallPolicy associations. Always compute#FirewallPoliciesListAssociations for lists of firewallPolicy associations.", "default": "compute#firewallPoliciesListAssociationsResponse", "type": "string" }, "associations": { "description": "A list of associations.", "type": "array", "items": { "$ref": "FirewallPolicyAssociation" } } } }, "GlobalOrganizationSetPolicyRequest": { "id": "GlobalOrganizationSetPolicyRequest", "type": "object", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.", "$ref": "Policy" }, "bindings": { "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.", "type": "array", "items": { "$ref": "Binding" } }, "etag": { "description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.", "type": "string", "format": "byte" } } }, "NetworkFirewallPolicyAggregatedList": { "id": "NetworkFirewallPolicyAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#networkFirewallPoliciesAggregatedList for lists of network firewall policies.", "default": "compute#networkFirewallPolicyAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of FirewallPoliciesScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of addresses.", "$ref": "FirewallPoliciesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "FirewallPoliciesScopedList": { "id": "FirewallPoliciesScopedList", "type": "object", "properties": { "firewallPolicies": { "description": "A list of firewall policies contained in this scope.", "type": "array", "items": { "$ref": "FirewallPolicy" } }, "warning": { "description": "Informational warning which replaces the list of firewall policies when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse": { "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", "type": "object", "properties": { "firewalls": { "description": "Effective firewalls on the network.", "type": "array", "items": { "$ref": "Firewall" } }, "firewallPolicys": { "description": "[Output only] Effective firewalls from firewall policy. It applies to Regional Network Firewall Policies in the specified region, Global Network Firewall Policies and Hierachial Firewall Policies which are associated with the network.", "type": "array", "items": { "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" } } } }, "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy", "type": "object", "properties": { "name": { "description": "[Output Only] The name of the firewall policy.", "type": "string" }, "type": { "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", "type": "string", "enumDescriptions": [ "", "", "", "", "", "" ], "enum": [ "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", "SYSTEM_GLOBAL", "SYSTEM_REGIONAL", "UNSPECIFIED" ] }, "displayName": { "description": "[Output Only] The display name of the firewall policy.", "type": "string" }, "rules": { "description": "[Output only] The rules that apply to the network.", "type": "array", "items": { "$ref": "FirewallPolicyRule" } }, "packetMirroringRules": { "description": "[Output only] The packet mirroring rules that apply to the network.", "type": "array", "items": { "$ref": "FirewallPolicyRule" } }, "priority": { "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", "type": "integer", "format": "int32" } } }, "SecurityPolicyList": { "id": "SecurityPolicyList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies", "default": "compute#securityPolicyList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of SecurityPolicy resources.", "type": "array", "items": { "$ref": "SecurityPolicy" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "SecurityPolicy": { "id": "SecurityPolicy", "description": "Represents a Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.", "type": "object", "properties": { "userDefinedFields": { "description": "Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: \"ipv4_fragment_offset\" base: IPV4 offset: 6 size: 2 mask: \"0x1fff\"", "type": "array", "items": { "$ref": "SecurityPolicyUserDefinedField" } }, "kind": { "description": "[Output only] Type of the resource. Always compute#securityPolicyfor security policies", "default": "compute#securityPolicy", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "rules": { "description": "A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match \"\" for srcIpRanges and for the networkMatch condition every field must be either match \"\" or not set). If no rules are provided when creating a security policy, a default rule with action \"allow\" will be added.", "type": "array", "items": { "$ref": "SecurityPolicyRule" } }, "adaptiveProtectionConfig": { "$ref": "SecurityPolicyAdaptiveProtectionConfig" }, "ddosProtectionConfig": { "$ref": "SecurityPolicyDdosProtectionConfig" }, "advancedOptionsConfig": { "$ref": "SecurityPolicyAdvancedOptionsConfig" }, "recaptchaOptionsConfig": { "$ref": "SecurityPolicyRecaptchaOptionsConfig" }, "fingerprint": { "description": "Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.", "type": "string", "format": "byte" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "type": { "description": "The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "CLOUD_ARMOR", "CLOUD_ARMOR_EDGE", "CLOUD_ARMOR_NETWORK" ] }, "labels": { "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key\/value pair must comply with RFC1035. Label values may be empty.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.", "type": "string", "format": "byte" }, "region": { "description": "[Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.", "type": "string" } } }, "SecurityPolicyUserDefinedField": { "id": "SecurityPolicyUserDefinedField", "type": "object", "properties": { "name": { "description": "The name of this field. Must be unique within the policy.", "type": "string" }, "base": { "description": "The base relative to which 'offset' is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required", "type": "string", "enumDescriptions": [ "", "", "", "" ], "enum": [ "IPV4", "IPV6", "TCP", "UDP" ] }, "offset": { "description": "Offset of the first byte of the field (in network byte order) relative to 'base'.", "type": "integer", "format": "int32" }, "size": { "description": "Size of the field in bytes. Valid values: 1-4.", "type": "integer", "format": "int32" }, "mask": { "description": "If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with \"0x\"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.", "type": "string" } } }, "SecurityPolicyRule": { "id": "SecurityPolicyRule", "description": "Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).", "type": "object", "properties": { "kind": { "description": "[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules", "default": "compute#securityPolicyRule", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "priority": { "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.", "type": "integer", "format": "int32" }, "match": { "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.", "$ref": "SecurityPolicyRuleMatcher" }, "networkMatch": { "description": "A match condition that incoming packets are evaluated against for CLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding 'action' is enforced. The match criteria for a rule consists of built-in match fields (like 'srcIpRanges') and potentially multiple user-defined match fields ('userDefinedFields'). Field values may be extracted directly from the packet or derived from it (e.g. 'srcRegionCodes'). Some fields may not be present in every packet (e.g. 'srcPorts'). A user-defined field is only present if the base header is found in the packet and the entire field is in bounds. Each match field may specify which values can match it, listing one or more ranges, prefixes, or exact values that are considered a match for the field. A field value must be present in order to match a specified match field. If no match values are specified for a match field, then any field value is considered to match it, and it's not required to be present. For strings specifying '' is also equivalent to match all. For a packet to match a rule, all specified match fields must match the corresponding field values derived from the packet. Example: networkMatch: srcIpRanges: - \"192.0.2.0\/24\" - \"198.51.100.0\/24\" userDefinedFields: - name: \"ipv4_fragment_offset\" values: - \"1-0x1fff\" The above match condition matches packets with a source IP in 192.0.2.0\/24 or 198.51.100.0\/24 and a user-defined field named \"ipv4_fragment_offset\" with a value between 1 and 0x1fff inclusive.", "$ref": "SecurityPolicyRuleNetworkMatcher" }, "action": { "description": "The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. ", "type": "string" }, "preview": { "description": "If set to true, the specified action is not enforced.", "type": "boolean" }, "rateLimitOptions": { "description": "Must be specified if the action is \"rate_based_ban\" or \"throttle\". Cannot be specified for any other actions.", "$ref": "SecurityPolicyRuleRateLimitOptions" }, "headerAction": { "description": "Optional, additional actions that are performed on headers. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", "$ref": "SecurityPolicyRuleHttpHeaderAction" }, "redirectOptions": { "description": "Parameters defining the redirect action. Cannot be specified for any other actions. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", "$ref": "SecurityPolicyRuleRedirectOptions" }, "preconfiguredWafConfig": { "description": "Preconfigured WAF configuration to be applied for the rule. If the rule does not evaluate preconfigured WAF rules, i.e., if evaluatePreconfiguredWaf() is not used, this field will have no effect.", "$ref": "SecurityPolicyRulePreconfiguredWafConfig" } } }, "SecurityPolicyRuleMatcher": { "id": "SecurityPolicyRuleMatcher", "description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.", "type": "object", "properties": { "expr": { "description": "User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-')` require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies.", "$ref": "Expr" }, "exprOptions": { "description": "The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').", "$ref": "SecurityPolicyRuleMatcherExprOptions" }, "versionedExpr": { "description": "Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.", "type": "string", "enumDescriptions": [ "Matches the source IP address of a request to the IP ranges supplied in config." ], "enum": [ "SRC_IPS_V1" ] }, "config": { "description": "The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.", "$ref": "SecurityPolicyRuleMatcherConfig" } } }, "SecurityPolicyRuleMatcherExprOptions": { "id": "SecurityPolicyRuleMatcherExprOptions", "type": "object", "properties": { "recaptchaOptions": { "description": "reCAPTCHA configuration options to be applied for the rule. If the rule does not evaluate reCAPTCHA tokens, this field has no effect.", "$ref": "SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions" } } }, "SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions": { "id": "SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions", "type": "object", "properties": { "actionTokenSiteKeys": { "description": "A list of site keys to be used during the validation of reCAPTCHA action-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.", "type": "array", "items": { "type": "string" } }, "sessionTokenSiteKeys": { "description": "A list of site keys to be used during the validation of reCAPTCHA session-tokens. The provided site keys need to be created from reCAPTCHA API under the same project where the security policy is created.", "type": "array", "items": { "type": "string" } } } }, "SecurityPolicyRuleMatcherConfig": { "id": "SecurityPolicyRuleMatcherConfig", "type": "object", "properties": { "srcIpRanges": { "description": "CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.", "type": "array", "items": { "type": "string" } } } }, "SecurityPolicyRuleNetworkMatcher": { "id": "SecurityPolicyRuleNetworkMatcher", "description": "Represents a match condition that incoming network traffic is evaluated against.", "type": "object", "properties": { "userDefinedFields": { "description": "User-defined fields. Each element names a defined field and lists the matching values for that field.", "type": "array", "items": { "$ref": "SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch" } }, "srcIpRanges": { "description": "Source IPv4\/IPv6 addresses or CIDR prefixes, in standard text format.", "type": "array", "items": { "type": "string" } }, "destIpRanges": { "description": "Destination IPv4\/IPv6 addresses or CIDR prefixes, in standard text format.", "type": "array", "items": { "type": "string" } }, "ipProtocols": { "description": "IPv4 protocol \/ IPv6 next header (after extension headers). Each element can be an 8-bit unsigned decimal number (e.g. \"6\"), range (e.g. \"253-254\"), or one of the following protocol names: \"tcp\", \"udp\", \"icmp\", \"esp\", \"ah\", \"ipip\", or \"sctp\".", "type": "array", "items": { "type": "string" } }, "srcPorts": { "description": "Source port numbers for TCP\/UDP\/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. \"80\") or range (e.g. \"0-1023\").", "type": "array", "items": { "type": "string" } }, "destPorts": { "description": "Destination port numbers for TCP\/UDP\/SCTP. Each element can be a 16-bit unsigned decimal number (e.g. \"80\") or range (e.g. \"0-1023\").", "type": "array", "items": { "type": "string" } }, "srcRegionCodes": { "description": "Two-letter ISO 3166-1 alpha-2 country code associated with the source IP address.", "type": "array", "items": { "type": "string" } }, "srcAsns": { "description": "BGP Autonomous System Number associated with the source IP address.", "type": "array", "items": { "type": "integer", "format": "uint32" } } } }, "SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch": { "id": "SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch", "type": "object", "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 decimal or hexadecimal (starting with \"0x\") number (e.g. \"64\") or range (e.g. \"0x400-0x7ff\").", "type": "array", "items": { "type": "string" } } } }, "SecurityPolicyRuleRateLimitOptions": { "id": "SecurityPolicyRuleRateLimitOptions", "type": "object", "properties": { "rateLimitThreshold": { "description": "Threshold at which to begin ratelimiting.", "$ref": "SecurityPolicyRuleRateLimitOptionsThreshold" }, "conformAction": { "description": "Action to take for requests that are under the configured rate limit threshold. Valid option is \"allow\" only.", "type": "string" }, "exceedAction": { "description": "Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are `deny(STATUS)`, where valid values for `STATUS` are 403, 404, 429, and 502, and `redirect`, where the redirect parameters come from `exceedRedirectOptions` below. The `redirect` action is only supported in Global Security Policies of type CLOUD_ARMOR.", "type": "string" }, "exceedRedirectOptions": { "description": "Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", "$ref": "SecurityPolicyRuleRedirectOptions" }, "enforceOnKey": { "description": "Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if \"enforceOnKey\" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country\/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS\/SSL fingerprint if the client connects using HTTPS, HTTP\/2 or HTTP\/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on \"userIpRequestHeaders\" configured with the security policy. If there is no \"userIpRequestHeaders\" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS\/SSL fingerprint if the client connects using HTTPS, HTTP\/2 or HTTP\/3. If not available, the key type defaults to ALL. ", "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "" ], "enum": [ "ALL", "HTTP_COOKIE", "HTTP_HEADER", "HTTP_PATH", "IP", "REGION_CODE", "SNI", "TLS_JA3_FINGERPRINT", "TLS_JA4_FINGERPRINT", "USER_IP", "XFF_IP" ] }, "enforceOnKeyName": { "description": "Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.", "type": "string" }, "enforceOnKeyConfigs": { "description": "If specified, any combination of values of enforce_on_key_type\/enforce_on_key_name is treated as the key on which ratelimit threshold\/action is enforced. You can specify up to 3 enforce_on_key_configs. If enforce_on_key_configs is specified, enforce_on_key must not be specified.", "type": "array", "items": { "$ref": "SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig" } }, "banThreshold": { "description": "Can only be specified if the action for the rule is \"rate_based_ban\". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.", "$ref": "SecurityPolicyRuleRateLimitOptionsThreshold" }, "banDurationSec": { "description": "Can only be specified if the action for the rule is \"rate_based_ban\". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.", "type": "integer", "format": "int32" } } }, "SecurityPolicyRuleRateLimitOptionsThreshold": { "id": "SecurityPolicyRuleRateLimitOptionsThreshold", "type": "object", "properties": { "count": { "description": "Number of HTTP(S) requests for calculating the threshold.", "type": "integer", "format": "int32" }, "intervalSec": { "description": "Interval over which the threshold is computed.", "type": "integer", "format": "int32" } } }, "SecurityPolicyRuleRedirectOptions": { "id": "SecurityPolicyRuleRedirectOptions", "type": "object", "properties": { "type": { "description": "Type of the redirect action.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "EXTERNAL_302", "GOOGLE_RECAPTCHA" ] }, "target": { "description": "Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.", "type": "string" } } }, "SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig": { "id": "SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig", "type": "object", "properties": { "enforceOnKeyType": { "description": "Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if \"enforceOnKeyConfigs\" is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under \"enforceOnKeyName\". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country\/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS\/SSL fingerprint if the client connects using HTTPS, HTTP\/2 or HTTP\/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on \"userIpRequestHeaders\" configured with the security policy. If there is no \"userIpRequestHeaders\" configuration or an IP address cannot be resolved from it, the key type defaults to IP. - TLS_JA4_FINGERPRINT: JA4 TLS\/SSL fingerprint if the client connects using HTTPS, HTTP\/2 or HTTP\/3. If not available, the key type defaults to ALL. ", "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "" ], "enum": [ "ALL", "HTTP_COOKIE", "HTTP_HEADER", "HTTP_PATH", "IP", "REGION_CODE", "SNI", "TLS_JA3_FINGERPRINT", "TLS_JA4_FINGERPRINT", "USER_IP", "XFF_IP" ] }, "enforceOnKeyName": { "description": "Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.", "type": "string" } } }, "SecurityPolicyRuleHttpHeaderAction": { "id": "SecurityPolicyRuleHttpHeaderAction", "type": "object", "properties": { "requestHeadersToAdds": { "description": "The list of request headers to add or overwrite if they're already present.", "type": "array", "items": { "$ref": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption" } } } }, "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption": { "id": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption", "type": "object", "properties": { "headerName": { "description": "The name of the header to set.", "type": "string" }, "headerValue": { "description": "The value to set the named header to.", "type": "string" } } }, "SecurityPolicyRulePreconfiguredWafConfig": { "id": "SecurityPolicyRulePreconfiguredWafConfig", "type": "object", "properties": { "exclusions": { "description": "A list of exclusions to apply during preconfigured WAF evaluation.", "type": "array", "items": { "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusion" } } } }, "SecurityPolicyRulePreconfiguredWafConfigExclusion": { "id": "SecurityPolicyRulePreconfiguredWafConfigExclusion", "type": "object", "properties": { "targetRuleSet": { "description": "Target WAF rule set to apply the preconfigured WAF exclusion.", "type": "string" }, "targetRuleIds": { "description": "A list of target rule IDs under the WAF rule set to apply the preconfigured WAF exclusion. If omitted, it refers to all the rule IDs under the WAF rule set.", "type": "array", "items": { "type": "string" } }, "requestHeadersToExclude": { "description": "A list of request header names whose value will be excluded from inspection during preconfigured WAF evaluation.", "type": "array", "items": { "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams" } }, "requestCookiesToExclude": { "description": "A list of request cookie names whose value will be excluded from inspection during preconfigured WAF evaluation.", "type": "array", "items": { "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams" } }, "requestQueryParamsToExclude": { "description": "A list of request query parameter names whose value will be excluded from inspection during preconfigured WAF evaluation. Note that the parameter can be in the query string or in the POST body.", "type": "array", "items": { "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams" } }, "requestUrisToExclude": { "description": "A list of request URIs from the request line to be excluded from inspection during preconfigured WAF evaluation. When specifying this field, the query or fragment part should be excluded.", "type": "array", "items": { "$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams" } } } }, "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams": { "id": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams", "type": "object", "properties": { "val": { "description": "The value of the field.", "type": "string" }, "op": { "description": "The match operator for the field.", "type": "string", "enumDescriptions": [ "The operator matches if the field value contains the specified value.", "The operator matches if the field value ends with the specified value.", "The operator matches if the field value equals the specified value.", "The operator matches if the field value is any value.", "The operator matches if the field value starts with the specified value." ], "enum": [ "CONTAINS", "ENDS_WITH", "EQUALS", "EQUALS_ANY", "STARTS_WITH" ] } } }, "SecurityPolicyAdaptiveProtectionConfig": { "id": "SecurityPolicyAdaptiveProtectionConfig", "description": "Configuration options for Cloud Armor Adaptive Protection (CAAP).", "type": "object", "properties": { "layer7DdosDefenseConfig": { "description": "If set to true, enables Cloud Armor Machine Learning.", "$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig" } } }, "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig": { "id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig", "description": "Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", "type": "object", "properties": { "enable": { "description": "If set to true, enables CAAP for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", "type": "boolean" }, "ruleVisibility": { "description": "Rule visibility can be one of the following: STANDARD - opaque rules. (default) PREMIUM - transparent rules. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "PREMIUM", "STANDARD" ] }, "thresholdConfigs": { "description": "Configuration options for layer7 adaptive protection for various customizable thresholds.", "type": "array", "items": { "$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig" } } } }, "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig": { "id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig", "type": "object", "properties": { "name": { "description": "The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the security policy.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "autoDeployLoadThreshold": { "type": "number", "format": "float" }, "autoDeployConfidenceThreshold": { "type": "number", "format": "float" }, "autoDeployImpactedBaselineThreshold": { "type": "number", "format": "float" }, "autoDeployExpirationSec": { "type": "integer", "format": "int32" }, "detectionLoadThreshold": { "type": "number", "format": "float" }, "detectionAbsoluteQps": { "type": "number", "format": "float" }, "detectionRelativeToBaselineQps": { "type": "number", "format": "float" }, "trafficGranularityConfigs": { "description": "Configuration options for enabling Adaptive Protection to operate on specified granular traffic units.", "type": "array", "items": { "$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig" } } } }, "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig": { "id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig", "description": "Configurations to specifc granular traffic units processed by Adaptive Protection.", "type": "object", "properties": { "type": { "description": "Type of this configuration.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "HTTP_HEADER_HOST", "HTTP_PATH", "UNSPECIFIED_TYPE" ] }, "value": { "description": "Requests that match this value constitute a granular traffic unit.", "type": "string" }, "enableEachUniqueValue": { "description": "If enabled, traffic matching each unique value for the specified type constitutes a separate traffic unit. It can only be set to true if `value` is empty.", "type": "boolean" } } }, "SecurityPolicyDdosProtectionConfig": { "id": "SecurityPolicyDdosProtectionConfig", "type": "object", "properties": { "ddosProtection": { "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "ADVANCED", "ADVANCED_PREVIEW", "STANDARD" ] } } }, "SecurityPolicyAdvancedOptionsConfig": { "id": "SecurityPolicyAdvancedOptionsConfig", "type": "object", "properties": { "jsonParsing": { "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "DISABLED", "STANDARD", "STANDARD_WITH_GRAPHQL" ] }, "jsonCustomConfig": { "description": "Custom configuration to apply the JSON parsing. Only applicable when json_parsing is set to STANDARD.", "$ref": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig" }, "logLevel": { "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NORMAL", "VERBOSE" ] }, "userIpRequestHeaders": { "description": "An optional list of case-insensitive request header names to use for resolving the callers client IP address.", "type": "array", "items": { "type": "string" } } } }, "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig": { "id": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig", "type": "object", "properties": { "contentTypes": { "description": "A list of custom Content-Type header values to apply the JSON parsing. As per RFC 1341, a Content-Type header value has the following format: Content-Type := type \"\/\" subtype [\";\" parameter] When configuring a custom Content-Type header value, only the type\/subtype needs to be specified, and the parameters should be excluded.", "type": "array", "items": { "type": "string" } } } }, "SecurityPolicyRecaptchaOptionsConfig": { "id": "SecurityPolicyRecaptchaOptionsConfig", "type": "object", "properties": { "redirectSiteKey": { "description": "An optional field to supply a reCAPTCHA site key to be used for all the rules using the redirect action with the type of GOOGLE_RECAPTCHA under the security policy. The specified site key needs to be created from the reCAPTCHA API. The user is responsible for the validity of the specified site key. If not specified, a Google-managed site key is used. This field is only supported in Global Security Policies of type CLOUD_ARMOR.", "type": "string" } } }, "SecurityPoliciesListPreconfiguredExpressionSetsResponse": { "id": "SecurityPoliciesListPreconfiguredExpressionSetsResponse", "type": "object", "properties": { "preconfiguredExpressionSets": { "$ref": "SecurityPoliciesWafConfig" } } }, "SecurityPoliciesWafConfig": { "id": "SecurityPoliciesWafConfig", "type": "object", "properties": { "wafRules": { "$ref": "PreconfiguredWafSet" } } }, "PreconfiguredWafSet": { "id": "PreconfiguredWafSet", "type": "object", "properties": { "expressionSets": { "description": "List of entities that are currently supported for WAF rules.", "type": "array", "items": { "$ref": "WafExpressionSet" } } } }, "WafExpressionSet": { "id": "WafExpressionSet", "type": "object", "properties": { "id": { "description": "Google specified expression set ID. The format should be: - E.g. XSS-20170329 required", "type": "string" }, "aliases": { "description": "A list of alternate IDs. The format should be: - E.g. XSS-stable Generic suffix like \"stable\" is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can't be used for more than one entity set.", "type": "array", "items": { "type": "string" } }, "expressions": { "description": "List of available expressions.", "type": "array", "items": { "$ref": "WafExpressionSetExpression" } } } }, "WafExpressionSetExpression": { "id": "WafExpressionSetExpression", "type": "object", "properties": { "id": { "description": "Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive. required", "type": "string" }, "sensitivity": { "description": "The sensitivity value associated with the WAF rule ID. This corresponds to the ModSecurity paranoia level, ranging from 1 to 4. 0 is reserved for opt-in only rules.", "type": "integer", "format": "int32" } } }, "SecurityPoliciesAggregatedList": { "id": "SecurityPoliciesAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#securityPolicyAggregatedList for lists of Security Policies.", "default": "compute#securityPoliciesAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of SecurityPoliciesScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of security policies.", "$ref": "SecurityPoliciesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "etag": { "type": "string" }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "SecurityPoliciesScopedList": { "id": "SecurityPoliciesScopedList", "type": "object", "properties": { "securityPolicies": { "description": "A list of SecurityPolicies contained in this scope.", "type": "array", "items": { "$ref": "SecurityPolicy" } }, "warning": { "description": "Informational warning which replaces the list of security policies when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InstanceList": { "id": "InstanceList", "description": "Contains a list of instances.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.", "default": "compute#instanceList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Instance resources.", "type": "array", "items": { "$ref": "Instance" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Instance": { "id": "Instance", "description": "Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#instance for instances.", "default": "compute#instance", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.instances.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "tags": { "description": "Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.", "$ref": "Tags" }, "machineType": { "description": "Full or partial URL of the machine type resource to use for this instance, in the format: zones\/zone\/machineTypes\/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones\/us-central1-f\/machineTypes\/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones\/zone\/machineTypes\/custom-CPUS-MEMORY For example: zones\/us-central1-f\/machineTypes\/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.", "type": "string" }, "status": { "description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.", "type": "string", "enumDescriptions": [ "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", "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 is 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 failure)." ], "enum": [ "DEPROVISIONING", "PROVISIONING", "REPAIRING", "RUNNING", "STAGING", "STOPPED", "STOPPING", "SUSPENDED", "SUSPENDING", "TERMINATED" ] }, "statusMessage": { "description": "[Output Only] An optional, human-readable explanation of the status.", "type": "string" }, "zone": { "description": "[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "canIpForward": { "description": "Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .", "type": "boolean" }, "networkInterfaces": { "description": "An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.", "type": "array", "items": { "$ref": "NetworkInterface" } }, "disks": { "description": "Array of disks associated with this instance. Persistent disks must be created before you can assign them.", "type": "array", "items": { "$ref": "AttachedDisk" } }, "metadata": { "description": "The metadata key\/value pairs assigned to this instance. This includes custom metadata and predefined keys.", "$ref": "Metadata" }, "serviceAccounts": { "description": "A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.", "type": "array", "items": { "$ref": "ServiceAccount" } }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "scheduling": { "description": "Sets the scheduling options for this instance.", "$ref": "Scheduling" }, "cpuPlatform": { "description": "[Output Only] The CPU platform used by this instance.", "type": "string" }, "labels": { "description": "Labels to apply to this instance. These can be later modified by the setLabels method.", "type": "object", "additionalProperties": { "type": "string" } }, "params": { "description": "Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.", "$ref": "InstanceParams" }, "labelFingerprint": { "description": "A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance.", "type": "string", "format": "byte" }, "instanceEncryptionKey": { "description": "Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation.", "$ref": "CustomerEncryptionKey" }, "minCpuPlatform": { "description": "Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\".", "type": "string" }, "guestAccelerators": { "description": "A list of the type and count of accelerator cards attached to the instance.", "type": "array", "items": { "$ref": "AcceleratorConfig" } }, "startRestricted": { "description": "[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.", "type": "boolean" }, "deletionProtection": { "description": "Whether the resource should be protected against deletion.", "type": "boolean" }, "resourcePolicies": { "description": "Resource policies applied to this instance.", "type": "array", "items": { "type": "string" } }, "sourceMachineImage": { "description": "Source machine image", "type": "string" }, "reservationAffinity": { "description": "Specifies the reservations that this instance can consume from.", "$ref": "ReservationAffinity" }, "hostname": { "description": "Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.", "type": "string" }, "displayDevice": { "description": "Enables display device for the instance.", "$ref": "DisplayDevice" }, "shieldedInstanceConfig": { "$ref": "ShieldedInstanceConfig" }, "shieldedInstanceIntegrityPolicy": { "$ref": "ShieldedInstanceIntegrityPolicy" }, "sourceMachineImageEncryptionKey": { "description": "Source machine image encryption key when creating an instance from a machine image.", "$ref": "CustomerEncryptionKey" }, "confidentialInstanceConfig": { "$ref": "ConfidentialInstanceConfig" }, "fingerprint": { "description": "Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance.", "type": "string", "format": "byte" }, "privateIpv6GoogleAccess": { "description": "The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.", "type": "string", "enumDescriptions": [ "Bidirectional private IPv6 access to\/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", "Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", "Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork." ], "enum": [ "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE", "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE", "INHERIT_FROM_SUBNETWORK" ] }, "advancedMachineFeatures": { "description": "Controls for advanced machine-related behavior features.", "$ref": "AdvancedMachineFeatures" }, "lastStartTimestamp": { "description": "[Output Only] Last start timestamp in RFC3339 text format.", "type": "string" }, "lastStopTimestamp": { "description": "[Output Only] Last stop timestamp in RFC3339 text format.", "type": "string" }, "lastSuspendedTimestamp": { "description": "[Output Only] Last suspended timestamp in RFC3339 text format.", "type": "string" }, "satisfiesPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "satisfiesPzi": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "resourceStatus": { "description": "[Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.", "$ref": "ResourceStatus" }, "networkPerformanceConfig": { "$ref": "NetworkPerformanceConfig" }, "keyRevocationActionType": { "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Indicates user chose no operation.", "Indicates user chose to opt for VM shutdown on key revocation." ], "enum": [ "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", "NONE", "STOP" ] } } }, "Tags": { "id": "Tags", "description": "A set of instance tags.", "type": "object", "properties": { "items": { "description": "An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "array", "items": { "type": "string" } }, "fingerprint": { "description": "Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. To see the latest fingerprint, make get() request to the instance.", "type": "string", "format": "byte" } } }, "NetworkInterface": { "id": "NetworkInterface", "description": "A network interface resource attached to an instance.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.", "default": "compute#networkInterface", "type": "string" }, "network": { "description": "URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global\/networks\/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/global\/networks\/ network - projects\/project\/global\/networks\/network - global\/networks\/default ", "type": "string" }, "subnetwork": { "description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/regions\/region \/subnetworks\/subnetwork - regions\/region\/subnetworks\/subnetwork ", "type": "string" }, "networkIP": { "description": "An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.", "type": "string" }, "ipv6Address": { "description": "An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.", "type": "string" }, "internalIpv6PrefixLength": { "description": "The prefix length of the primary internal IPv6 range.", "type": "integer", "format": "int32" }, "name": { "description": "[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0.", "type": "string" }, "accessConfigs": { "description": "An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.", "type": "array", "items": { "$ref": "AccessConfig" } }, "ipv6AccessConfigs": { "description": "An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.", "type": "array", "items": { "$ref": "AccessConfig" } }, "aliasIpRanges": { "description": "An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.", "type": "array", "items": { "$ref": "AliasIpRange" } }, "fingerprint": { "description": "Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.", "type": "string", "format": "byte" }, "stackType": { "description": "The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations.", "type": "string", "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." ], "enum": [ "IPV4_IPV6", "IPV4_ONLY", "IPV6_ONLY" ] }, "ipv6AccessType": { "description": "[Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6.", "type": "string", "enumDescriptions": [ "This network interface can have external IPv6.", "This network interface can have internal IPv6." ], "enum": [ "EXTERNAL", "INTERNAL" ] }, "queueCount": { "description": "The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.", "type": "integer", "format": "int32" }, "nicType": { "description": "The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.", "type": "string", "enumDescriptions": [ "GVNIC", "IDPF", "IRDMA", "MRDMA", "No type specified.", "VIRTIO" ], "enum": [ "GVNIC", "IDPF", "IRDMA", "MRDMA", "UNSPECIFIED_NIC_TYPE", "VIRTIO_NET" ] }, "networkAttachment": { "description": "The URL of the network attachment that this interface should connect to in the following format: projects\/{project_number}\/regions\/{region_name}\/networkAttachments\/{network_attachment_name}.", "type": "string" } } }, "AccessConfig": { "id": "AccessConfig", "description": "An access configuration attached to an instance's network interface. Only one access config per instance is supported.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#accessConfig for access configs.", "default": "compute#accessConfig", "type": "string" }, "type": { "description": "The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "DIRECT_IPV6", "ONE_TO_ONE_NAT" ] }, "name": { "description": "The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6.", "type": "string" }, "natIP": { "description": "Applies to accessConfigs (IPv4) only. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.", "type": "string" }, "externalIpv6": { "description": "Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork.", "type": "string" }, "externalIpv6PrefixLength": { "description": "Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range.", "type": "integer", "format": "int32" }, "setPublicPtr": { "description": "Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated.", "type": "boolean" }, "publicPtrDomainName": { "description": "The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be created for first IP in associated external IPv6 range.", "type": "string" }, "networkTier": { "description": "This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.", "type": "string", "enumDescriptions": [ "Public internet quality with fixed bandwidth.", "High quality, Google-grade network tier, support for all networking products.", "Public internet quality, only limited support for other networking products.", "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured." ], "enum": [ "FIXED_STANDARD", "PREMIUM", "STANDARD", "STANDARD_OVERRIDES_FIXED_STANDARD" ] }, "securityPolicy": { "description": "The resource URL for the security policy associated with this access config.", "type": "string" } } }, "AliasIpRange": { "id": "AliasIpRange", "description": "An alias IP range attached to an instance's network interface.", "type": "object", "properties": { "ipCidrRange": { "description": "The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as \/24) or a CIDR-formatted string (such as 10.1.2.0\/24).", "type": "string" }, "subnetworkRangeName": { "description": "The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.", "type": "string" } } }, "AttachedDisk": { "id": "AttachedDisk", "description": "An instance-attached disk resource.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.", "default": "compute#attachedDisk", "type": "string" }, "type": { "description": "Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "PERSISTENT", "SCRATCH" ] }, "mode": { "description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.", "type": "string", "enumDescriptions": [ "Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.", "[Default]* Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode." ], "enum": [ "READ_ONLY", "READ_WRITE" ] }, "savedState": { "description": "For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop\/Suspend). Read-only in the api.", "type": "string", "enumDescriptions": [ "[Default] Disk state has not been preserved.", "Disk state has been preserved." ], "enum": [ "DISK_SAVED_STATE_UNSPECIFIED", "PRESERVED" ] }, "source": { "description": "Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk.", "type": "string" }, "deviceName": { "description": "Specifies a unique device name of your choice that is reflected into the \/dev\/disk\/by-id\/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.", "type": "string" }, "index": { "description": "[Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.", "type": "integer", "format": "int32" }, "boot": { "description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.", "type": "boolean" }, "initializeParams": { "description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.", "$ref": "AttachedDiskInitializeParams" }, "autoDelete": { "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).", "type": "boolean" }, "licenses": { "description": "[Output Only] Any valid publicly visible licenses.", "type": "array", "items": { "type": "string" } }, "interface": { "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. For most machine types, the default is SCSI. Local SSDs can use either NVME or SCSI. In certain configurations, persistent disks can use NVMe. For more information, see About persistent disks.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NVME", "SCSI" ] }, "guestOsFeatures": { "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.", "type": "array", "items": { "$ref": "GuestOsFeature" } }, "diskEncryptionKey": { "description": "Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Note: Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. You cannot create VMs that have disks with customer-supplied keys using the bulk insert method.", "$ref": "CustomerEncryptionKey" }, "diskSizeGb": { "description": "The size of the disk in GB.", "type": "string", "format": "int64" }, "shieldedInstanceInitialState": { "description": "[Output Only] shielded vm initial state stored on disk", "$ref": "InitialStateConfig" }, "forceAttach": { "description": "[Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.", "type": "boolean" }, "architecture": { "description": "[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64.", "type": "string", "enumDescriptions": [ "Default value indicating Architecture is not set.", "Machines with architecture ARM64", "Machines with architecture X86_64" ], "enum": [ "ARCHITECTURE_UNSPECIFIED", "ARM64", "X86_64" ] } } }, "AttachedDiskInitializeParams": { "id": "AttachedDiskInitializeParams", "description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This field is persisted and returned for instanceTemplate and not returned in the context of instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.", "type": "object", "properties": { "diskName": { "description": "Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.", "type": "string" }, "sourceImage": { "description": "The source image to create this disk. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family\/debian-9 to use the latest Debian 9 image: projects\/debian-cloud\/global\/images\/family\/debian-9 Alternatively, use a specific version of a public operating system image: projects\/debian-cloud\/global\/images\/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global\/images\/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family\/family-name: global\/images\/family\/my-image-family If the source image is deleted later, this field will not be set.", "type": "string" }, "diskSizeGb": { "description": "Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.", "type": "string", "format": "int64" }, "diskType": { "description": "Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/diskTypes\/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/diskTypes\/diskType - projects\/project\/zones\/zone\/diskTypes\/diskType - zones\/zone\/diskTypes\/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.", "type": "string" }, "sourceImageEncryptionKey": { "description": "The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.", "$ref": "CustomerEncryptionKey" }, "labels": { "description": "Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.", "type": "object", "additionalProperties": { "type": "string" } }, "sourceSnapshot": { "description": "The source snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global\/snapshots\/my-backup If the source snapshot is deleted later, this field will not be set. Note: You cannot create VMs in bulk using a snapshot as the source. Use an image instead when you create VMs using the bulk insert method.", "type": "string" }, "sourceSnapshotEncryptionKey": { "description": "The customer-supplied encryption key of the source snapshot.", "$ref": "CustomerEncryptionKey" }, "description": { "description": "An optional description. Provide this property when creating the disk.", "type": "string" }, "replicaZones": { "description": "Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone.", "type": "array", "items": { "type": "string" } }, "resourcePolicies": { "description": "Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.", "type": "array", "items": { "type": "string" } }, "onUpdateAction": { "description": "Specifies which action to take on instance update with this disk. Default is to use the existing disk.", "type": "string", "enumDescriptions": [ "Always recreate the disk.", "Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.", "Use the existing disk, this is the default behaviour." ], "enum": [ "RECREATE_DISK", "RECREATE_DISK_IF_SOURCE_CHANGED", "USE_EXISTING_DISK" ] }, "provisionedIops": { "description": "Indicates how many IOPS to provision for the disk. This sets the number of I\/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.", "type": "string", "format": "int64" }, "licenses": { "description": "A list of publicly visible licenses. Reserved for Google's use.", "type": "array", "items": { "type": "string" } }, "architecture": { "description": "The architecture of the attached disk. Valid values are arm64 or x86_64.", "type": "string", "enumDescriptions": [ "Default value indicating Architecture is not set.", "Machines with architecture ARM64", "Machines with architecture X86_64" ], "enum": [ "ARCHITECTURE_UNSPECIFIED", "ARM64", "X86_64" ] }, "resourceManagerTags": { "description": "Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys\/{tag_key_id}`, and values are in the format `tagValues\/456`. The field is ignored (both PUT & PATCH) when empty.", "type": "object", "additionalProperties": { "type": "string" } }, "provisionedThroughput": { "description": "Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must greater than or equal to 1.", "type": "string", "format": "int64" }, "enableConfidentialCompute": { "description": "Whether this disk is using confidential compute mode.", "type": "boolean" }, "storagePool": { "description": "The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/storagePools\/storagePool - projects\/project\/zones\/zone\/storagePools\/storagePool - zones\/zone\/storagePools\/storagePool ", "type": "string" } } }, "Metadata": { "id": "Metadata", "description": "A metadata key\/value entry.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#metadata for metadata.", "default": "compute#metadata", "type": "string" }, "fingerprint": { "description": "Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource.", "type": "string", "format": "byte" }, "items": { "description": "Array of key\/value pairs. The total size of all keys and values must be less than 512 KB.", "type": "array", "items": { "description": "Metadata", "type": "object", "properties": { "key": { "description": "Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.", "pattern": "[a-zA-Z0-9-_]{1,128}", "annotations": { "required": [ "compute.instances.insert", "compute.projects.setCommonInstanceMetadata" ] }, "type": "string" }, "value": { "description": "Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).", "annotations": { "required": [ "compute.instances.insert", "compute.projects.setCommonInstanceMetadata" ] }, "type": "string" } } } } } }, "ServiceAccount": { "id": "ServiceAccount", "description": "A service account.", "type": "object", "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.", "type": "array", "items": { "type": "string" } } } }, "Scheduling": { "id": "Scheduling", "description": "Sets the scheduling options for an Instance.", "type": "object", "properties": { "maxRunDuration": { "description": "Specifies the max run duration for the given instance. If specified, the instance termination action will be performed at the end of the run duration.", "$ref": "Duration" }, "terminationTime": { "description": "Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time.", "type": "string" }, "onInstanceStopAction": { "$ref": "SchedulingOnInstanceStopAction" }, "onHostMaintenance": { "description": "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy.", "type": "string", "enumDescriptions": [ "[Default] Allows Compute Engine to automatically migrate instances out of the way of maintenance events.", "Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events." ], "enum": [ "MIGRATE", "TERMINATE" ] }, "automaticRestart": { "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.", "type": "boolean" }, "preemptible": { "description": "Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.", "type": "boolean" }, "nodeAffinities": { "description": "A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.", "type": "array", "items": { "$ref": "SchedulingNodeAffinity" } }, "minNodeCpus": { "description": "The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.", "type": "integer", "format": "int32" }, "locationHint": { "description": "An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.", "type": "string" }, "availabilityDomain": { "description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", "type": "integer", "format": "int32" }, "provisioningModel": { "description": "Specifies the provisioning model of the instance.", "type": "string", "enumDescriptions": [ "Heavily discounted, no guaranteed runtime.", "Standard provisioning with user controlled runtime, no discounts." ], "enum": [ "SPOT", "STANDARD" ] }, "instanceTerminationAction": { "description": "Specifies the termination action for the instance.", "type": "string", "enumDescriptions": [ "Delete the VM.", "Default value. This value is unused.", "Stop the VM without storing in-memory content. default action." ], "enum": [ "DELETE", "INSTANCE_TERMINATION_ACTION_UNSPECIFIED", "STOP" ] }, "hostErrorTimeoutSeconds": { "description": "Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.", "type": "integer", "format": "int32" }, "localSsdRecoveryTimeout": { "description": "Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.", "$ref": "Duration" } } }, "Duration": { "id": "Duration", "description": "A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". Range is approximately 10,000 years.", "type": "object", "properties": { "seconds": { "description": "Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec\/min * 60 min\/hr * 24 hr\/day * 365.25 days\/year * 10000 years", "type": "string", "format": "int64" }, "nanos": { "description": "Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.", "type": "integer", "format": "int32" } } }, "SchedulingOnInstanceStopAction": { "id": "SchedulingOnInstanceStopAction", "description": "Defines the behaviour for instances with the instance_termination_action STOP.", "type": "object", "properties": { "discardLocalSsd": { "description": "If true, the contents of any attached Local SSD disks will be discarded else, the Local SSD data will be preserved when the instance is stopped at the end of the run duration\/termination time.", "type": "boolean" } } }, "SchedulingNodeAffinity": { "id": "SchedulingNodeAffinity", "description": "Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.", "type": "object", "properties": { "key": { "description": "Corresponds to the label key of Node resource.", "type": "string" }, "operator": { "description": "Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.", "type": "string", "enumDescriptions": [ "Requires Compute Engine to seek for matched nodes.", "Requires Compute Engine to avoid certain nodes.", "" ], "enum": [ "IN", "NOT_IN", "OPERATOR_UNSPECIFIED" ] }, "values": { "description": "Corresponds to the label values of Node resource.", "type": "array", "items": { "type": "string" } } } }, "InstanceParams": { "id": "InstanceParams", "description": "Additional instance params.", "type": "object", "properties": { "resourceManagerTags": { "description": "Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys\/{tag_key_id}`, and values are in the format `tagValues\/456`. The field is ignored (both PUT & PATCH) when empty.", "type": "object", "additionalProperties": { "type": "string" } } } }, "AcceleratorConfig": { "id": "AcceleratorConfig", "description": "A specification of the type and number of accelerator cards attached to the instance.", "type": "object", "properties": { "acceleratorType": { "description": "Full or partial URL of the accelerator type resource to attach to this instance. For example: projects\/my-project\/zones\/us-central1-c\/acceleratorTypes\/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.", "type": "string" }, "acceleratorCount": { "description": "The number of the guest accelerator cards exposed to this instance.", "type": "integer", "format": "int32" } } }, "ReservationAffinity": { "id": "ReservationAffinity", "description": "Specifies the reservations that this instance can consume from.", "type": "object", "properties": { "consumeReservationType": { "description": "Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.", "type": "string", "enumDescriptions": [ "Consume any allocation available.", "Do not consume from any allocated capacity.", "Must consume from a specific reservation. Must specify key value fields for specifying the reservations.", "" ], "enum": [ "ANY_RESERVATION", "NO_RESERVATION", "SPECIFIC_RESERVATION", "UNSPECIFIED" ] }, "key": { "description": "Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com\/reservation-name as the key and specify the name of your reservation as its value.", "type": "string" }, "values": { "description": "Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or \"projects\/different-project\/reservations\/some-reservation-name\" to target a shared reservation in the same zone but in a different project.", "type": "array", "items": { "type": "string" } } } }, "DisplayDevice": { "id": "DisplayDevice", "description": "A set of Display Device options", "type": "object", "properties": { "enableDisplay": { "description": "Defines whether the instance has Display enabled.", "type": "boolean" } } }, "ShieldedInstanceConfig": { "id": "ShieldedInstanceConfig", "description": "A set of Shielded Instance options.", "type": "object", "properties": { "enableSecureBoot": { "description": "Defines whether the instance has Secure Boot enabled. Disabled by default.", "type": "boolean" }, "enableVtpm": { "description": "Defines whether the instance has the vTPM enabled. Enabled by default.", "type": "boolean" }, "enableIntegrityMonitoring": { "description": "Defines whether the instance has integrity monitoring enabled. Enabled by default.", "type": "boolean" } } }, "ShieldedInstanceIntegrityPolicy": { "id": "ShieldedInstanceIntegrityPolicy", "description": "The policy describes the baseline against which Instance boot integrity is measured.", "type": "object", "properties": { "updateAutoLearnPolicy": { "description": "Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.", "type": "boolean" } } }, "ConfidentialInstanceConfig": { "id": "ConfidentialInstanceConfig", "description": "A set of Confidential Instance options.", "type": "object", "properties": { "enableConfidentialCompute": { "description": "Defines whether the instance should have confidential compute enabled.", "type": "boolean" }, "confidentialInstanceType": { "description": "Defines the type of technology used by the confidential instance.", "type": "string", "enumDescriptions": [ "No type specified. Do not use this value.", "AMD Secure Encrypted Virtualization.", "AMD Secure Encrypted Virtualization - Secure Nested Paging.", "Intel Trust Domain eXtension." ], "enum": [ "CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED", "SEV", "SEV_SNP", "TDX" ] } } }, "AdvancedMachineFeatures": { "id": "AdvancedMachineFeatures", "description": "Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled).", "type": "object", "properties": { "enableNestedVirtualization": { "description": "Whether to enable nested virtualization or not (default is false).", "type": "boolean" }, "threadsPerCore": { "description": "The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.", "type": "integer", "format": "int32" }, "visibleCoreCount": { "description": "The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.", "type": "integer", "format": "int32" }, "enableUefiNetworking": { "description": "Whether to enable UEFI networking for instance creation.", "type": "boolean" }, "performanceMonitoringUnit": { "description": "Type of Performance Monitoring Unit requested on instance.", "type": "string", "enumDescriptions": [ "Architecturally defined non-LLC events.", "Most documented core\/L2 and LLC events.", "", "Most documented core\/L2 events." ], "enum": [ "ARCHITECTURAL", "ENHANCED", "PERFORMANCE_MONITORING_UNIT_UNSPECIFIED", "STANDARD" ] }, "turboMode": { "description": "Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode.", "type": "string" } } }, "ResourceStatus": { "id": "ResourceStatus", "description": "Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls.", "type": "object", "properties": { "scheduling": { "$ref": "ResourceStatusScheduling" }, "upcomingMaintenance": { "$ref": "UpcomingMaintenance" }, "physicalHost": { "description": "[Output Only] The precise location of your instance within the zone's data center, including the block, sub-block, and host. The field is formatted as follows: blockId\/subBlockId\/hostId.", "type": "string" } } }, "ResourceStatusScheduling": { "id": "ResourceStatusScheduling", "type": "object", "properties": { "availabilityDomain": { "description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", "type": "integer", "format": "int32" } } }, "UpcomingMaintenance": { "id": "UpcomingMaintenance", "description": "Upcoming Maintenance notification information.", "type": "object", "properties": { "type": { "description": "Defines the type of maintenance.", "type": "string", "enumDescriptions": [ "Scheduled maintenance (e.g. maintenance after uptime guarantee is complete).", "No type specified. Do not use this value.", "Unscheduled maintenance (e.g. emergency maintenance during uptime guarantee)." ], "enum": [ "SCHEDULED", "UNKNOWN_TYPE", "UNSCHEDULED" ] }, "canReschedule": { "description": "Indicates if the maintenance can be customer triggered.", "type": "boolean" }, "windowStartTime": { "description": "The current start time of the maintenance window. This timestamp value is in RFC3339 text format.", "type": "string" }, "windowEndTime": { "description": "The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.", "type": "string" }, "latestWindowStartTime": { "description": "The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.", "type": "string" }, "maintenanceStatus": { "type": "string", "enumDescriptions": [ "There is ongoing maintenance on this VM.", "There is pending maintenance.", "Unknown maintenance status. Do not use this value." ], "enum": [ "ONGOING", "PENDING", "UNKNOWN" ] } } }, "NetworkPerformanceConfig": { "id": "NetworkPerformanceConfig", "type": "object", "properties": { "totalEgressBandwidthTier": { "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "DEFAULT", "TIER_1" ] } } }, "InstanceAggregatedList": { "id": "InstanceAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.", "default": "compute#instanceAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "An object that contains a list of instances scoped by zone.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of instances.", "$ref": "InstancesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "InstancesScopedList": { "id": "InstancesScopedList", "type": "object", "properties": { "instances": { "description": "[Output Only] A list of instances contained in this scope.", "type": "array", "items": { "$ref": "Instance" } }, "warning": { "description": "[Output Only] Informational warning which replaces the list of instances when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InstanceListReferrers": { "id": "InstanceListReferrers", "description": "Contains a list of instance referrers.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.", "default": "compute#instanceListReferrers", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Reference resources.", "type": "array", "items": { "$ref": "Reference" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Reference": { "id": "Reference", "description": "Represents a reference to a resource.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#reference for references.", "default": "compute#reference", "type": "string" }, "target": { "description": "URL of the resource to which this reference points.", "type": "string" }, "referenceType": { "description": "A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF ", "type": "string" }, "referrer": { "description": "URL of the resource which refers to the target.", "type": "string" } } }, "InstancesReportHostAsFaultyRequest": { "id": "InstancesReportHostAsFaultyRequest", "type": "object", "properties": { "faultReasons": { "type": "array", "items": { "$ref": "InstancesReportHostAsFaultyRequestFaultReason" } }, "disruptionSchedule": { "description": "The disruption schedule for the VM. Default to IMMEDIATE.", "type": "string", "enumDescriptions": [ "Not used. Required as per aip\/126.", "Delay disruption for caller control. Will be default soon.", "Default value. Disrupt the VM immediately." ], "enum": [ "DISRUPTION_SCHEDULE_UNSPECIFIED", "FUTURE", "IMMEDIATE" ] } } }, "InstancesReportHostAsFaultyRequestFaultReason": { "id": "InstancesReportHostAsFaultyRequestFaultReason", "type": "object", "properties": { "behavior": { "type": "string", "enumDescriptions": [ "Public reportable behaviors", "", "", "" ], "enum": [ "BEHAVIOR_UNSPECIFIED", "PERFORMANCE", "SILENT_DATA_CORRUPTION", "UNRECOVERABLE_GPU_ERROR" ] }, "description": { "type": "string" } } }, "SerialPortOutput": { "id": "SerialPortOutput", "description": "An instance serial console output.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.", "default": "compute#serialPortOutput", "type": "string" }, "contents": { "description": "[Output Only] The contents of the console output.", "type": "string" }, "start": { "description": "The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the `start` value that was specified in the request.", "type": "string", "format": "int64" }, "next": { "description": "[Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the `contents` property. Use this value in the next request as the start parameter.", "type": "string", "format": "int64" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" } } }, "Screenshot": { "id": "Screenshot", "description": "An instance's screenshot.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#screenshot for the screenshots.", "default": "compute#screenshot", "type": "string" }, "contents": { "description": "[Output Only] The Base64-encoded screenshot data.", "type": "string" } } }, "GuestAttributes": { "id": "GuestAttributes", "description": "A guest attributes entry.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.", "default": "compute#guestAttributes", "type": "string" }, "variableKey": { "description": "The key to search for.", "type": "string" }, "variableValue": { "description": "[Output Only] The value found for the requested key.", "type": "string" }, "queryPath": { "description": "The path to be queried. This can be the default namespace ('') or a nested namespace ('\\\/') or a specified key ('\\\/\\').", "type": "string" }, "queryValue": { "description": "[Output Only] The value of the requested queried path.", "$ref": "GuestAttributesValue" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" } } }, "GuestAttributesValue": { "id": "GuestAttributesValue", "description": "Array of guest attribute namespace\/key\/value tuples.", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "GuestAttributesEntry" } } } }, "GuestAttributesEntry": { "id": "GuestAttributesEntry", "description": "A guest attributes namespace\/key\/value entry.", "type": "object", "properties": { "namespace": { "description": "Namespace for the guest attribute entry.", "type": "string" }, "key": { "description": "Key for the guest attribute entry.", "type": "string" }, "value": { "description": "Value for the guest attribute entry.", "type": "string" } } }, "InstancesSetMachineResourcesRequest": { "id": "InstancesSetMachineResourcesRequest", "type": "object", "properties": { "guestAccelerators": { "description": "A list of the type and count of accelerator cards attached to the instance.", "type": "array", "items": { "$ref": "AcceleratorConfig" } } } }, "InstancesSetMachineTypeRequest": { "id": "InstancesSetMachineTypeRequest", "type": "object", "properties": { "machineType": { "description": "Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones\/us-central1-f\/machineTypes\/n1-standard-1", "type": "string" } } }, "InstancesSetMinCpuPlatformRequest": { "id": "InstancesSetMinCpuPlatformRequest", "type": "object", "properties": { "minCpuPlatform": { "description": "Minimum cpu\/platform this instance should be started at.", "type": "string" } } }, "InstancesSetLabelsRequest": { "id": "InstancesSetLabelsRequest", "type": "object", "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.", "type": "string", "format": "byte" } } }, "InstancesSetNameRequest": { "id": "InstancesSetNameRequest", "type": "object", "properties": { "name": { "description": "The name to be applied to the instance. Needs to be RFC 1035 compliant.", "type": "string" }, "currentName": { "description": "The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.", "type": "string" } } }, "InstancesStartWithEncryptionKeyRequest": { "id": "InstancesStartWithEncryptionKeyRequest", "type": "object", "properties": { "disks": { "description": "Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified.", "type": "array", "items": { "$ref": "CustomerEncryptionKeyProtectedDisk" } } } }, "CustomerEncryptionKeyProtectedDisk": { "id": "CustomerEncryptionKeyProtectedDisk", "type": "object", "properties": { "source": { "description": "Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. For example: \"source\": \"\/compute\/v1\/projects\/project_id\/zones\/zone\/disks\/ disk_name ", "type": "string" }, "diskEncryptionKey": { "description": "Decrypts data associated with the disk with a customer-supplied encryption key.", "$ref": "CustomerEncryptionKey" } } }, "InstancesSetServiceAccountRequest": { "id": "InstancesSetServiceAccountRequest", "type": "object", "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.", "type": "array", "items": { "type": "string" } } } }, "InstancesAddResourcePoliciesRequest": { "id": "InstancesAddResourcePoliciesRequest", "type": "object", "properties": { "resourcePolicies": { "description": "Resource policies to be added to this instance.", "type": "array", "items": { "type": "string" } } } }, "InstancesRemoveResourcePoliciesRequest": { "id": "InstancesRemoveResourcePoliciesRequest", "type": "object", "properties": { "resourcePolicies": { "description": "Resource policies to be removed from this instance.", "type": "array", "items": { "type": "string" } } } }, "InstancesSetSecurityPolicyRequest": { "id": "InstancesSetSecurityPolicyRequest", "type": "object", "properties": { "securityPolicy": { "description": "A full or partial URL to a security policy to add to this instance. If this field is set to an empty string it will remove the associated security policy.", "type": "string" }, "networkInterfaces": { "description": "The network interfaces that the security policy will be applied to. Network interfaces use the nicN naming format. You can only set a security policy for network interfaces with an access config.", "type": "array", "items": { "type": "string" } } } }, "ShieldedInstanceIdentity": { "id": "ShieldedInstanceIdentity", "description": "A Shielded Instance Identity.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.", "default": "compute#shieldedInstanceIdentity", "type": "string" }, "signingKey": { "description": "An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.", "$ref": "ShieldedInstanceIdentityEntry" }, "encryptionKey": { "description": "An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.", "$ref": "ShieldedInstanceIdentityEntry" } } }, "ShieldedInstanceIdentityEntry": { "id": "ShieldedInstanceIdentityEntry", "description": "A Shielded Instance Identity Entry.", "type": "object", "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" } } }, "BulkInsertInstanceResource": { "id": "BulkInsertInstanceResource", "description": "A transient resource used in compute.instances.bulkInsert and compute.regionInstances.bulkInsert . This resource is not persisted anywhere, it is used only for processing the requests.", "type": "object", "properties": { "count": { "description": "The maximum number of instances to create.", "type": "string", "format": "int64" }, "minCount": { "description": "The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created and instances already created will be deleted.", "type": "string", "format": "int64" }, "namePattern": { "description": "The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern must contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: a name_pattern of inst-#### generates instance names such as inst-0001 and inst-0002. If existing instances in the same project and zone have names that match the name pattern then the generated instance numbers start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### begin with inst-0051. The name pattern placeholder #...# can contain up to 18 characters.", "type": "string" }, "perInstanceProperties": { "description": "Per-instance properties to be set on individual instances. Keys of this map specify requested instance names. Can be empty if name_pattern is used.", "type": "object", "additionalProperties": { "$ref": "BulkInsertInstanceResourcePerInstanceProperties" } }, "sourceInstanceTemplate": { "description": "Specifies the instance template from which to create instances. You may combine sourceInstanceTemplate with instanceProperties to override specific values from an existing instance template. Bulk API follows the semantics of JSON Merge Patch described by RFC 7396. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project \/global\/instanceTemplates\/instanceTemplate - projects\/project\/global\/instanceTemplates\/instanceTemplate - global\/instanceTemplates\/instanceTemplate This field is optional.", "type": "string" }, "instanceProperties": { "description": "The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.", "$ref": "InstanceProperties" }, "locationPolicy": { "description": "Policy for choosing target zone. For more information, see Create VMs in bulk.", "$ref": "LocationPolicy" } } }, "BulkInsertInstanceResourcePerInstanceProperties": { "id": "BulkInsertInstanceResourcePerInstanceProperties", "description": "Per-instance properties to be set on individual instances. To be extended in the future.", "type": "object", "properties": { "name": { "description": "This field is only temporary. It will be removed. Do not use it.", "type": "string" }, "hostname": { "description": "Specifies the hostname of the instance. More details in: https:\/\/cloud.google.com\/compute\/docs\/instances\/custom-hostname-vm#naming_convention", "type": "string" } } }, "InstanceProperties": { "id": "InstanceProperties", "type": "object", "properties": { "description": { "description": "An optional text description for the instances that are created from these properties.", "type": "string" }, "tags": { "description": "A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.", "$ref": "Tags" }, "resourceManagerTags": { "description": "Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys\/{tag_key_id}`, and values are in the format `tagValues\/456`. The field is ignored (both PUT & PATCH) when empty.", "type": "object", "additionalProperties": { "type": "string" } }, "machineType": { "description": "The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example `n2-standard-4`. If you use the machine type full or partial URL, for example `projects\/my-l7ilb-project\/zones\/us-central1-a\/machineTypes\/n2-standard-4`, the request will result in an `INTERNAL_ERROR`.", "annotations": { "required": [ "compute.instanceTemplates.insert" ] }, "type": "string" }, "canIpForward": { "description": "Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.", "type": "boolean" }, "networkInterfaces": { "description": "An array of network access configurations for this interface.", "type": "array", "items": { "$ref": "NetworkInterface" } }, "disks": { "description": "An array of disks that are associated with the instances that are created from these properties.", "type": "array", "items": { "$ref": "AttachedDisk" } }, "metadata": { "description": "The metadata key\/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.", "$ref": "Metadata" }, "serviceAccounts": { "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.", "type": "array", "items": { "$ref": "ServiceAccount" } }, "scheduling": { "description": "Specifies the scheduling options for the instances that are created from these properties.", "$ref": "Scheduling" }, "labels": { "description": "Labels to apply to instances that are created from these properties.", "type": "object", "additionalProperties": { "type": "string" } }, "guestAccelerators": { "description": "A list of guest accelerator cards' type and count to use for instances created from these properties.", "type": "array", "items": { "$ref": "AcceleratorConfig" } }, "minCpuPlatform": { "description": "Minimum cpu\/platform to be used by instances. The instance may be scheduled on the specified or newer cpu\/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\". For more information, read Specifying a Minimum CPU Platform.", "type": "string" }, "reservationAffinity": { "description": "Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.", "$ref": "ReservationAffinity" }, "shieldedInstanceConfig": { "description": "Note that for MachineImage, this is not supported yet.", "$ref": "ShieldedInstanceConfig" }, "resourcePolicies": { "description": "Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.", "type": "array", "items": { "type": "string" } }, "confidentialInstanceConfig": { "description": "Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.", "$ref": "ConfidentialInstanceConfig" }, "privateIpv6GoogleAccess": { "description": "The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.", "type": "string", "enumDescriptions": [ "Bidirectional private IPv6 access to\/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", "Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", "Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork." ], "enum": [ "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE", "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE", "INHERIT_FROM_SUBNETWORK" ] }, "advancedMachineFeatures": { "description": "Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.", "$ref": "AdvancedMachineFeatures" }, "networkPerformanceConfig": { "description": "Note that for MachineImage, this is not supported yet.", "$ref": "NetworkPerformanceConfig" }, "keyRevocationActionType": { "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Indicates user chose no operation.", "Indicates user chose to opt for VM shutdown on key revocation." ], "enum": [ "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", "NONE", "STOP" ] } } }, "LocationPolicy": { "id": "LocationPolicy", "description": "Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region).", "type": "object", "properties": { "locations": { "description": "Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones\/us-central1-a.", "type": "object", "additionalProperties": { "$ref": "LocationPolicyLocation" } }, "targetShape": { "description": "Strategy for distributing VMs across zones in a region.", "type": "string", "enumDescriptions": [ "GCE picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.", "GCE always selects a single zone for all the VMs, optimizing for resource quotas, available reservations and general capacity. Recommended for batch workloads that cannot tollerate distribution over multiple zones. This the default shape in Bulk Insert and Capacity Advisor APIs.", "GCE prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across allowed zones to minimize the impact of zonal failure. Recommended for highly available serving workloads." ], "enum": [ "ANY", "ANY_SINGLE_ZONE", "BALANCED" ] } } }, "LocationPolicyLocation": { "id": "LocationPolicyLocation", "type": "object", "properties": { "preference": { "description": "Preference for a given location. Set to either ALLOW or DENY.", "type": "string", "enumDescriptions": [ "Location is allowed for use.", "Location is prohibited.", "Default value, unused." ], "enum": [ "ALLOW", "DENY", "PREFERENCE_UNSPECIFIED" ] }, "constraints": { "description": "Constraints that the caller requires on the result distribution in this zone.", "$ref": "LocationPolicyLocationConstraints" } } }, "LocationPolicyLocationConstraints": { "id": "LocationPolicyLocationConstraints", "description": "Per-zone constraints on location policy for this zone.", "type": "object", "properties": { "maxCount": { "description": "Maximum number of items that are allowed to be placed in this zone. The value must be non-negative.", "type": "integer", "format": "int32" } } }, "InstancesGetEffectiveFirewallsResponse": { "id": "InstancesGetEffectiveFirewallsResponse", "type": "object", "properties": { "firewalls": { "description": "Effective firewalls on the instance.", "type": "array", "items": { "$ref": "Firewall" } }, "firewallPolicys": { "description": "[Output Only] Effective firewalls from firewall policies.", "type": "array", "items": { "$ref": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy" } } } }, "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { "id": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy", "type": "object", "properties": { "name": { "description": "[Output Only] The name of the firewall policy.", "type": "string" }, "type": { "description": "[Output Only] The type of the firewall policy. Can be one of HIERARCHY, NETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.", "type": "string", "enumDescriptions": [ "", "", "", "", "", "" ], "enum": [ "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", "SYSTEM_GLOBAL", "SYSTEM_REGIONAL", "UNSPECIFIED" ] }, "shortName": { "description": "[Output Only] The short name of the firewall policy.", "type": "string" }, "displayName": { "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.", "deprecated": true, "type": "string" }, "rules": { "description": "[Output Only] The rules that apply to the instance. Only rules that target the specific VM instance are returned if target service accounts or target secure tags are specified in the rules.", "type": "array", "items": { "$ref": "FirewallPolicyRule" } }, "packetMirroringRules": { "description": "[Output Only] The packet mirroring rules that apply to the instance.", "type": "array", "items": { "$ref": "FirewallPolicyRule" } }, "priority": { "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", "type": "integer", "format": "int32" } } }, "ReservationList": { "id": "ReservationList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource.Always compute#reservationsList for listsof reservations", "default": "compute#reservationList", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string" }, "items": { "description": "[Output Only] A list of Allocation resources.", "type": "array", "items": { "$ref": "Reservation" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" } } }, "Reservation": { "id": "Reservation", "description": "Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.", "type": "object", "properties": { "specificReservation": { "description": "Reservation for instances with specific machine shapes.", "$ref": "AllocationSpecificSKUReservation" }, "aggregateReservation": { "description": "Reservation for aggregated resources, providing shape flexibility.", "$ref": "AllocationAggregateReservation" }, "kind": { "description": "[Output Only] Type of the resource. Always compute#reservations for reservations.", "default": "compute#reservation", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" }, "zone": { "description": "Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "name": { "description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.instances.insert" ] }, "type": "string" }, "commitment": { "description": "[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.", "type": "string" }, "specificReservationRequired": { "description": "Indicates whether the reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.", "type": "boolean" }, "status": { "description": "[Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress. ", "type": "string", "enumDescriptions": [ "Reservation resources are being allocated.", "Reservation deletion is in progress.", "", "Reservation resources have been allocated, and the reservation is ready for use.", "Reservation update is in progress." ], "enum": [ "CREATING", "DELETING", "INVALID", "READY", "UPDATING" ] }, "shareSettings": { "description": "Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.", "$ref": "ShareSettings" }, "satisfiesPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "resourcePolicies": { "description": "Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.", "type": "object", "additionalProperties": { "type": "string" } }, "resourceStatus": { "description": "[Output Only] Status information for Reservation resource.", "$ref": "AllocationResourceStatus" }, "reservationSharingPolicy": { "description": "Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services.", "$ref": "AllocationReservationSharingPolicy" } } }, "AllocationSpecificSKUReservation": { "id": "AllocationSpecificSKUReservation", "description": "This reservation type allows to pre allocate specific instance configuration.", "type": "object", "properties": { "instanceProperties": { "description": "The instance properties for the reservation.", "$ref": "AllocationSpecificSKUAllocationReservedInstanceProperties" }, "count": { "description": "Specifies the number of resources that are allocated.", "type": "string", "format": "int64" }, "inUseCount": { "description": "[Output Only] Indicates how many instances are in use.", "type": "string", "format": "int64" }, "assuredCount": { "description": "[Output Only] Indicates how many instances are actually usable currently.", "type": "string", "format": "int64" }, "sourceInstanceTemplate": { "description": "Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project \/global\/instanceTemplates\/instanceTemplate - projects\/project\/global\/instanceTemplates\/instanceTemplate - global\/instanceTemplates\/instanceTemplate ", "type": "string" } } }, "AllocationSpecificSKUAllocationReservedInstanceProperties": { "id": "AllocationSpecificSKUAllocationReservedInstanceProperties", "description": "Properties of the SKU instances being reserved. Next ID: 9", "type": "object", "properties": { "machineType": { "description": "Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.", "type": "string" }, "guestAccelerators": { "description": "Specifies accelerator type and count.", "type": "array", "items": { "$ref": "AcceleratorConfig" } }, "minCpuPlatform": { "description": "Minimum cpu platform the reservation.", "type": "string" }, "localSsds": { "description": "Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.", "type": "array", "items": { "$ref": "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk" } }, "locationHint": { "description": "An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.", "type": "string" } } }, "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk": { "id": "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk", "type": "object", "properties": { "diskSizeGb": { "description": "Specifies the size of the disk in base-2 GB.", "type": "string", "format": "int64" }, "interface": { "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NVME", "SCSI" ] } } }, "AllocationAggregateReservation": { "id": "AllocationAggregateReservation", "description": "This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation.", "type": "object", "properties": { "vmFamily": { "description": "The VM family that all instances scheduled against this reservation must belong to.", "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "" ], "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" ] }, "reservedResources": { "description": "List of reserved resources (CPUs, memory, accelerators).", "type": "array", "items": { "$ref": "AllocationAggregateReservationReservedResourceInfo" } }, "inUseResources": { "description": "[Output only] List of resources currently in use.", "type": "array", "items": { "$ref": "AllocationAggregateReservationReservedResourceInfo" } }, "workloadType": { "description": "The workload type of the instances that will target this reservation.", "type": "string", "enumDescriptions": [ "Reserved resources will be optimized for BATCH workloads, such as ML training.", "Reserved resources will be optimized for SERVING workloads, such as ML inference.", "" ], "enum": [ "BATCH", "SERVING", "UNSPECIFIED" ] } } }, "AllocationAggregateReservationReservedResourceInfo": { "id": "AllocationAggregateReservationReservedResourceInfo", "type": "object", "properties": { "accelerator": { "description": "Properties of accelerator resources in this reservation.", "$ref": "AllocationAggregateReservationReservedResourceInfoAccelerator" } } }, "AllocationAggregateReservationReservedResourceInfoAccelerator": { "id": "AllocationAggregateReservationReservedResourceInfoAccelerator", "type": "object", "properties": { "acceleratorCount": { "description": "Number of accelerators of specified type.", "type": "integer", "format": "int32" }, "acceleratorType": { "description": "Full or partial URL to accelerator type. e.g. \"projects\/{PROJECT}\/zones\/{ZONE}\/acceleratorTypes\/ct4l\"", "type": "string" } } }, "ShareSettings": { "id": "ShareSettings", "description": "The share setting for reservations and sole tenancy node groups.", "type": "object", "properties": { "shareType": { "description": "Type of sharing for this shared-reservation", "type": "string", "enumDescriptions": [ "Default value.", "Shared-reservation is open to entire Organization", "Default value. This value is unused.", "Shared-reservation is open to specific projects" ], "enum": [ "LOCAL", "ORGANIZATION", "SHARE_TYPE_UNSPECIFIED", "SPECIFIC_PROJECTS" ] }, "projectMap": { "description": "A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.", "type": "object", "additionalProperties": { "$ref": "ShareSettingsProjectConfig" } } } }, "ShareSettingsProjectConfig": { "id": "ShareSettingsProjectConfig", "description": "Config for each project in the share settings.", "type": "object", "properties": { "projectId": { "description": "The project ID, should be same as the key of this project config in the parent map.", "type": "string" } } }, "AllocationResourceStatus": { "id": "AllocationResourceStatus", "description": "[Output Only] Contains output only fields.", "type": "object", "properties": { "specificSkuAllocation": { "description": "Allocation Properties of this reservation.", "$ref": "AllocationResourceStatusSpecificSKUAllocation" } } }, "AllocationResourceStatusSpecificSKUAllocation": { "id": "AllocationResourceStatusSpecificSKUAllocation", "description": "Contains Properties set for the reservation.", "type": "object", "properties": { "sourceInstanceTemplateId": { "description": "ID of the instance template used to populate reservation properties.", "type": "string" }, "utilizations": { "description": "Per service utilization breakdown. The Key is the Google Cloud managed service name.", "type": "object", "additionalProperties": { "type": "string", "format": "int64" } } } }, "AllocationReservationSharingPolicy": { "id": "AllocationReservationSharingPolicy", "type": "object", "properties": { "serviceShareType": { "description": "Sharing config for all Google Cloud services.", "type": "string", "enumDescriptions": [ "Allow all Google Cloud managed services to share reservations.", "[Default] Disallow sharing with all Google Cloud services.", "" ], "enum": [ "ALLOW_ALL", "DISALLOW_ALL", "SERVICE_SHARE_TYPE_UNSPECIFIED" ] } } }, "ReservationAggregatedList": { "id": "ReservationAggregatedList", "description": "Contains a list of reservations.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#reservationAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Allocation resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of reservations.", "$ref": "ReservationsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "ReservationsScopedList": { "id": "ReservationsScopedList", "type": "object", "properties": { "reservations": { "description": "A list of reservations contained in this scope.", "type": "array", "items": { "$ref": "Reservation" } }, "warning": { "description": "Informational warning which replaces the list of reservations when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "ReservationsResizeRequest": { "id": "ReservationsResizeRequest", "type": "object", "properties": { "specificSkuCount": { "description": "Number of allocated resources can be resized with minimum = 1 and maximum = 1000.", "type": "string", "format": "int64" } } }, "InstanceGroupList": { "id": "InstanceGroupList", "description": "A list of InstanceGroup resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.", "default": "compute#instanceGroupList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InstanceGroup resources.", "type": "array", "items": { "$ref": "InstanceGroup" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InstanceGroup": { "id": "InstanceGroup", "description": "Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups.", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#instanceGroup for instance groups.", "default": "compute#instanceGroup", "type": "string" }, "id": { "description": "[Output Only] A unique identifier for this instance group, generated by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] The creation timestamp for this instance group in RFC3339 text format.", "type": "string" }, "name": { "description": "The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.instanceGroups.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "namedPorts": { "description": " Optional. Assigns a name to a port number. For example: {name: \"http\", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"app1\", port: 8080}, {name: \"app1\", port: 8081}, {name: \"app2\", port: 8082}] Named ports apply to all instances in this instance group. ", "type": "array", "items": { "$ref": "NamedPort" } }, "network": { "description": "[Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).", "type": "string" }, "fingerprint": { "description": "[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.", "type": "string", "format": "byte" }, "zone": { "description": "[Output Only] The URL of the zone where the instance group is located (for zonal resources).", "type": "string" }, "selfLink": { "description": "[Output Only] The URL for this instance group. The server generates this URL.", "type": "string" }, "size": { "description": "[Output Only] The total number of instances in the instance group.", "type": "integer", "format": "int32" }, "region": { "description": "[Output Only] The URL of the region where the instance group is located (for regional resources).", "type": "string" }, "subnetwork": { "description": "[Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).", "type": "string" } } }, "NamedPort": { "id": "NamedPort", "description": "The named port. For example: <\"http\", 80>.", "type": "object", "properties": { "name": { "description": "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.", "type": "string" }, "port": { "description": "The port number, which can be a value between 1 and 65535.", "type": "integer", "format": "int32" } } }, "InstanceGroupAggregatedList": { "id": "InstanceGroupAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.", "default": "compute#instanceGroupAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InstanceGroupsScopedList resources.", "type": "object", "additionalProperties": { "description": "The name of the scope that contains this set of instance groups.", "$ref": "InstanceGroupsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "InstanceGroupsScopedList": { "id": "InstanceGroupsScopedList", "type": "object", "properties": { "instanceGroups": { "description": "[Output Only] The list of instance groups that are contained in this scope.", "type": "array", "items": { "$ref": "InstanceGroup" } }, "warning": { "description": "[Output Only] An informational warning that replaces the list of instance groups when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InstanceGroupsAddInstancesRequest": { "id": "InstanceGroupsAddInstancesRequest", "type": "object", "properties": { "instances": { "description": "The list of instances to add to the instance group.", "type": "array", "items": { "$ref": "InstanceReference" } } } }, "InstanceReference": { "id": "InstanceReference", "type": "object", "properties": { "instance": { "description": "The URL for a specific instance. @required compute.instancegroups.addInstances\/removeInstances", "type": "string" } } }, "InstanceGroupsRemoveInstancesRequest": { "id": "InstanceGroupsRemoveInstancesRequest", "type": "object", "properties": { "instances": { "description": "The list of instances to remove from the instance group.", "type": "array", "items": { "$ref": "InstanceReference" } } } }, "InstanceGroupsListInstancesRequest": { "id": "InstanceGroupsListInstancesRequest", "type": "object", "properties": { "instanceState": { "description": "A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.", "type": "string", "enumDescriptions": [ "Includes all instances in the generated list regardless of their state.", "Includes instances in the generated list only if they have a RUNNING state." ], "enum": [ "ALL", "RUNNING" ] } } }, "InstanceGroupsListInstances": { "id": "InstanceGroupsListInstances", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.", "default": "compute#instanceGroupsListInstances", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InstanceWithNamedPorts resources.", "type": "array", "items": { "$ref": "InstanceWithNamedPorts" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InstanceWithNamedPorts": { "id": "InstanceWithNamedPorts", "type": "object", "properties": { "instance": { "description": "[Output Only] The URL of the instance.", "type": "string" }, "status": { "description": "[Output Only] The status of the instance.", "type": "string", "enumDescriptions": [ "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", "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 is 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 failure)." ], "enum": [ "DEPROVISIONING", "PROVISIONING", "REPAIRING", "RUNNING", "STAGING", "STOPPED", "STOPPING", "SUSPENDED", "SUSPENDING", "TERMINATED" ] }, "namedPorts": { "description": "[Output Only] The named ports that belong to this instance group.", "type": "array", "items": { "$ref": "NamedPort" } } } }, "InstanceGroupsSetNamedPortsRequest": { "id": "InstanceGroupsSetNamedPortsRequest", "type": "object", "properties": { "namedPorts": { "description": "The list of named ports to set for this instance group.", "type": "array", "items": { "$ref": "NamedPort" } }, "fingerprint": { "description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet.", "type": "string", "format": "byte" } } }, "RegionInstanceGroupList": { "id": "RegionInstanceGroupList", "description": "Contains a list of InstanceGroup resources.", "type": "object", "properties": { "kind": { "description": "The resource type.", "default": "compute#regionInstanceGroupList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InstanceGroup resources.", "type": "array", "items": { "$ref": "InstanceGroup" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "RegionInstanceGroupsListInstancesRequest": { "id": "RegionInstanceGroupsListInstancesRequest", "type": "object", "properties": { "instanceState": { "description": "Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.", "type": "string", "enumDescriptions": [ "Matches any status of the instances, running, non-running and others.", "Instance is in RUNNING state if it is running." ], "enum": [ "ALL", "RUNNING" ] }, "portName": { "description": "Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" } } }, "RegionInstanceGroupsListInstances": { "id": "RegionInstanceGroupsListInstances", "type": "object", "properties": { "kind": { "description": "The resource type.", "default": "compute#regionInstanceGroupsListInstances", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InstanceWithNamedPorts resources.", "type": "array", "items": { "$ref": "InstanceWithNamedPorts" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "RegionInstanceGroupsSetNamedPortsRequest": { "id": "RegionInstanceGroupsSetNamedPortsRequest", "type": "object", "properties": { "namedPorts": { "description": "The list of named ports to set for this instance group.", "type": "array", "items": { "$ref": "NamedPort" } }, "fingerprint": { "description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.", "type": "string", "format": "byte" } } }, "InstanceGroupManagerList": { "id": "InstanceGroupManagerList", "description": "[Output Only] A list of managed instance groups.", "type": "object", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InstanceGroupManager resources.", "type": "array", "items": { "$ref": "InstanceGroupManager" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "kind": { "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.", "default": "compute#instanceGroupManagerList", "type": "string" } } }, "InstanceGroupManager": { "id": "InstanceGroupManager", "description": "Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource.", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.", "default": "compute#instanceGroupManager", "type": "string" }, "id": { "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.", "type": "string" }, "name": { "description": "The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.instanceGroupManagers.insert", "compute.regionInstanceGroupManagers.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource.", "type": "string" }, "zone": { "description": "[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).", "type": "string" }, "region": { "description": "[Output Only] The URL of the region where the managed instance group resides (for regional resources).", "type": "string" }, "distributionPolicy": { "description": "Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.", "$ref": "DistributionPolicy" }, "instanceTemplate": { "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.", "type": "string" }, "versions": { "description": "Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.", "type": "array", "items": { "$ref": "InstanceGroupManagerVersion" } }, "allInstancesConfig": { "description": "Specifies configuration that overrides the instance template configuration for the group.", "$ref": "InstanceGroupManagerAllInstancesConfig" }, "instanceGroup": { "description": "[Output Only] The URL of the Instance Group resource.", "type": "string" }, "targetPools": { "description": "The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.", "type": "array", "items": { "type": "string" } }, "baseInstanceName": { "description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})\|([-a-z0-9]{0,51}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", "type": "string" }, "fingerprint": { "description": "Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.", "type": "string", "format": "byte" }, "currentActions": { "description": "[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.", "$ref": "InstanceGroupManagerActionsSummary" }, "status": { "description": "[Output Only] The status of this managed instance group.", "$ref": "InstanceGroupManagerStatus" }, "targetSize": { "description": "The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.", "annotations": { "required": [ "compute.instanceGroupManagers.insert", "compute.regionInstanceGroupManagers.insert" ] }, "type": "integer", "format": "int32" }, "instanceFlexibilityPolicy": { "description": "Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.", "$ref": "InstanceGroupManagerInstanceFlexibilityPolicy" }, "targetStoppedSize": { "description": "The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. ", "type": "integer", "format": "int32" }, "targetSuspendedSize": { "description": "The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method. ", "type": "integer", "format": "int32" }, "listManagedInstancesResults": { "description": "Pagination behavior of the listManagedInstances API method for this managed instance group.", "type": "string", "enumDescriptions": [ "(Default) Pagination is disabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are ignored and all instances are returned in a single response.", "Pagination is enabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are respected." ], "enum": [ "PAGELESS", "PAGINATED" ] }, "standbyPolicy": { "description": "Standby policy for stopped and suspended instances.", "$ref": "InstanceGroupManagerStandbyPolicy" }, "selfLink": { "description": "[Output Only] The URL for this managed instance group. The server defines this URL.", "type": "string" }, "autoHealingPolicies": { "description": "The autohealing policy for this managed instance group. You can specify only one value.", "type": "array", "items": { "$ref": "InstanceGroupManagerAutoHealingPolicy" } }, "updatePolicy": { "description": "The update policy for this managed instance group.", "$ref": "InstanceGroupManagerUpdatePolicy" }, "namedPorts": { "description": "[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.", "type": "array", "items": { "$ref": "NamedPort" } }, "statefulPolicy": { "description": "Stateful configuration for this Instanced Group Manager", "$ref": "StatefulPolicy" }, "instanceLifecyclePolicy": { "description": "The repair policy for this managed instance group.", "$ref": "InstanceGroupManagerInstanceLifecyclePolicy" }, "satisfiesPzi": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "satisfiesPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" } } }, "DistributionPolicy": { "id": "DistributionPolicy", "type": "object", "properties": { "zones": { "description": "Zones where the regional managed instance group will create and manage its instances.", "type": "array", "items": { "$ref": "DistributionPolicyZoneConfiguration" } }, "targetShape": { "description": "The distribution shape to which the group converges either proactively or on resize events (depending on the value set in updatePolicy.instanceRedistributionType).", "type": "string", "enumDescriptions": [ "The group picks zones for creating VM instances to fulfill the requested number of VMs within present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads that do not require high availability.", "The group creates all VM instances within a single zone. The zone is selected based on the present resource constraints and to maximize utilization of unused zonal reservations. Recommended for batch workloads with heavy interprocess communication.", "The group prioritizes acquisition of resources, scheduling VMs in zones where resources are available while distributing VMs as evenly as possible across selected zones to minimize the impact of zonal failure. Recommended for highly available serving workloads.", "The group schedules VM instance creation and deletion to achieve and maintain an even number of managed instances across the selected zones. The distribution is even when the number of managed instances does not differ by more than 1 between any two zones. Recommended for highly available serving workloads." ], "enum": [ "ANY", "ANY_SINGLE_ZONE", "BALANCED", "EVEN" ] } } }, "DistributionPolicyZoneConfiguration": { "id": "DistributionPolicyZoneConfiguration", "type": "object", "properties": { "zone": { "description": "The URL of the zone. The zone must exist in the region where the managed instance group is located.", "annotations": { "required": [ "compute.regionInstanceGroupManagers.insert" ] }, "type": "string" } } }, "InstanceGroupManagerVersion": { "id": "InstanceGroupManagerVersion", "type": "object", "properties": { "name": { "description": "Name of the version. Unique among all versions in the scope of this managed instance group.", "type": "string" }, "instanceTemplate": { "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the `targetSize` for this version is reached.", "type": "string" }, "targetSize": { "description": "Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent\/100 InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.", "$ref": "FixedOrPercent" } } }, "FixedOrPercent": { "id": "FixedOrPercent", "description": "Encapsulates numeric value that can be either absolute or relative.", "type": "object", "properties": { "fixed": { "description": "Specifies a fixed number of VM instances. This must be a positive integer.", "type": "integer", "format": "int32" }, "percent": { "description": "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.", "type": "integer", "format": "int32" }, "calculated": { "description": "[Output Only] Absolute value of VM instances calculated based on the specific mode. - If the value is fixed, then the calculated value is equal to the fixed value. - If the value is a percent, then the calculated value is percent\/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80\/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded. ", "type": "integer", "format": "int32" } } }, "InstanceGroupManagerAllInstancesConfig": { "id": "InstanceGroupManagerAllInstancesConfig", "type": "object", "properties": { "properties": { "description": "Properties to set on all instances in the group. You can add or modify properties using the instanceGroupManagers.patch or regionInstanceGroupManagers.patch. After setting allInstancesConfig on the group, you must update the group's instances to apply the configuration. To apply the configuration, set the group's updatePolicy.type field to use proactive updates or use the applyUpdatesToInstances method.", "$ref": "InstancePropertiesPatch" } } }, "InstancePropertiesPatch": { "id": "InstancePropertiesPatch", "description": "Represents the change that you want to make to the instance properties.", "type": "object", "properties": { "metadata": { "description": "The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata.", "type": "object", "additionalProperties": { "type": "string" } }, "labels": { "description": "The label key-value pairs that you want to patch onto the instance.", "type": "object", "additionalProperties": { "type": "string" } } } }, "InstanceGroupManagerActionsSummary": { "id": "InstanceGroupManagerActionsSummary", "type": "object", "properties": { "none": { "description": "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.", "type": "integer", "format": "int32" }, "creating": { "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully. If you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.", "type": "integer", "format": "int32" }, "creatingWithoutRetries": { "description": "[Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.", "type": "integer", "format": "int32" }, "verifying": { "description": "[Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.", "type": "integer", "format": "int32" }, "recreating": { "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.", "type": "integer", "format": "int32" }, "deleting": { "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.", "type": "integer", "format": "int32" }, "abandoning": { "description": "[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.", "type": "integer", "format": "int32" }, "restarting": { "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.", "type": "integer", "format": "int32" }, "refreshing": { "description": "[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.", "type": "integer", "format": "int32" }, "suspending": { "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be suspended or are currently being suspended.", "type": "integer", "format": "int32" }, "resuming": { "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be resumed or are currently being resumed.", "type": "integer", "format": "int32" }, "stopping": { "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be stopped or are currently being stopped.", "type": "integer", "format": "int32" }, "starting": { "description": "[Output Only] The number of instances in the managed instance group that are scheduled to be started or are currently being started.", "type": "integer", "format": "int32" } } }, "InstanceGroupManagerStatus": { "id": "InstanceGroupManagerStatus", "type": "object", "properties": { "isStable": { "description": "[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.", "type": "boolean" }, "allInstancesConfig": { "description": "[Output only] Status of all-instances configuration on the group.", "$ref": "InstanceGroupManagerStatusAllInstancesConfig" }, "versionTarget": { "description": "[Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager.", "$ref": "InstanceGroupManagerStatusVersionTarget" }, "stateful": { "description": "[Output Only] Stateful status of the given Instance Group Manager.", "$ref": "InstanceGroupManagerStatusStateful" }, "autoscaler": { "description": "[Output Only] The URL of the Autoscaler that targets this instance group manager.", "type": "string" } } }, "InstanceGroupManagerStatusAllInstancesConfig": { "id": "InstanceGroupManagerStatusAllInstancesConfig", "type": "object", "properties": { "effective": { "description": "[Output Only] A bit indicating whether this configuration has been applied to all managed instances in the group.", "type": "boolean" }, "currentRevision": { "description": "[Output Only] Current all-instances configuration revision. This value is in RFC3339 text format.", "type": "string" } } }, "InstanceGroupManagerStatusVersionTarget": { "id": "InstanceGroupManagerStatusVersionTarget", "type": "object", "properties": { "isReached": { "description": "[Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.", "type": "boolean" } } }, "InstanceGroupManagerStatusStateful": { "id": "InstanceGroupManagerStatusStateful", "type": "object", "properties": { "hasStatefulConfig": { "description": "[Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.", "type": "boolean" }, "perInstanceConfigs": { "description": "[Output Only] Status of per-instance configurations on the instances.", "$ref": "InstanceGroupManagerStatusStatefulPerInstanceConfigs" } } }, "InstanceGroupManagerStatusStatefulPerInstanceConfigs": { "id": "InstanceGroupManagerStatusStatefulPerInstanceConfigs", "type": "object", "properties": { "allEffective": { "description": "A bit indicating if all of the group's per-instance configurations (listed in the output of a listPerInstanceConfigs API call) have status EFFECTIVE or there are no per-instance-configs.", "type": "boolean" } } }, "InstanceGroupManagerInstanceFlexibilityPolicy": { "id": "InstanceGroupManagerInstanceFlexibilityPolicy", "type": "object", "properties": { "instanceSelections": { "description": "Named instance selections configuring properties that the group will use when creating new VMs.", "type": "object", "additionalProperties": { "$ref": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection" } } } }, "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection": { "id": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection", "type": "object", "properties": { "machineTypes": { "description": "Full machine-type names, e.g. \"n1-standard-16\".", "type": "array", "items": { "type": "string" } }, "rank": { "description": "Preference of this instance selection. Lower number means higher preference. MIG will first try to create a VM based on the machine-type with lowest rank and fallback to next rank based on availability. Machine types and instance selections with the same rank have the same preference.", "type": "integer", "format": "int32" } } }, "InstanceGroupManagerStandbyPolicy": { "id": "InstanceGroupManagerStandbyPolicy", "type": "object", "properties": { "initialDelaySec": { "description": "Specifies the number of seconds that the MIG should wait to suspend or stop a VM after that VM was created. The initial delay gives the initialization script the time to prepare your VM for a quick scale out. The value of initial delay must be between 0 and 3600 seconds. The default value is 0.", "type": "integer", "format": "int32" }, "mode": { "description": "Defines how a MIG resumes or starts VMs from a standby pool when the group scales out. The default mode is `MANUAL`.", "type": "string", "enumDescriptions": [ "MIG does not automatically resume or start VMs in the standby pool when the group scales out.", "MIG automatically resumes or starts VMs in the standby pool when the group scales out, and replenishes the standby pool afterwards." ], "enum": [ "MANUAL", "SCALE_OUT_POOL" ] } } }, "InstanceGroupManagerAutoHealingPolicy": { "id": "InstanceGroupManagerAutoHealingPolicy", "type": "object", "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 initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0.", "type": "integer", "format": "int32" } } }, "InstanceGroupManagerUpdatePolicy": { "id": "InstanceGroupManagerUpdatePolicy", "type": "object", "properties": { "type": { "description": "The type of update process. You can specify either PROACTIVE so that the MIG automatically updates VMs to the latest configurations or OPPORTUNISTIC so that you can select the VMs that you want to update.", "type": "string", "enumDescriptions": [ "MIG will apply new configurations to existing VMs only when you selectively target specific or all VMs to be updated.", "MIG will automatically apply new configurations to all or a subset of existing VMs and also to new VMs that are added to the group." ], "enum": [ "OPPORTUNISTIC", "PROACTIVE" ] }, "instanceRedistributionType": { "description": "The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. ", "type": "string", "enumDescriptions": [ "No action is being proactively performed in order to bring this IGM to its target instance distribution.", "This IGM will actively converge to its target instance distribution." ], "enum": [ "NONE", "PROACTIVE" ] }, "minimalAction": { "description": "Minimal action to be taken on an instance. Use this option to minimize disruption as much as possible or to apply a more disruptive action than is necessary. - To limit disruption as much as possible, set the minimal action to REFRESH. If your update requires a more disruptive action, Compute Engine performs the necessary action to execute the update. - To apply a more disruptive action than is strictly necessary, set the minimal action to RESTART or REPLACE. For example, Compute Engine does not need to restart a VM to change its metadata. But if your application reads instance metadata only when a VM is restarted, you can set the minimal action to RESTART in order to pick up metadata changes. ", "type": "string", "enumDescriptions": [ "Do not perform any action.", "Do not stop the instance.", "(Default.) Replace the instance according to the replacement method option.", "Stop the instance and start it again." ], "enum": [ "NONE", "REFRESH", "REPLACE", "RESTART" ] }, "mostDisruptiveAllowedAction": { "description": "Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to avoid restarting the VM and to limit disruption as much as possible. RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.", "type": "string", "enumDescriptions": [ "Do not perform any action.", "Do not stop the instance.", "(Default.) Replace the instance according to the replacement method option.", "Stop the instance and start it again." ], "enum": [ "NONE", "REFRESH", "REPLACE", "RESTART" ] }, "maxSurge": { "description": "The maximum number of instances that can be created above the specified targetSize during the update process. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxSurge is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge.", "$ref": "FixedOrPercent" }, "maxUnavailable": { "description": "The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's health check status must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. This value can be either a fixed number or, if the group has 10 or more instances, a percentage. If you set a percentage, the number of instances is rounded if necessary. The default value for maxUnavailable is a fixed value equal to the number of zones in which the managed instance group operates. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable.", "$ref": "FixedOrPercent" }, "replacementMethod": { "description": "What action should be used to replace instances. See minimal_action.REPLACE", "type": "string", "enumDescriptions": [ "Instances will be recreated (with the same name)", "Default option: instances will be deleted and created (with a new name)" ], "enum": [ "RECREATE", "SUBSTITUTE" ] } } }, "StatefulPolicy": { "id": "StatefulPolicy", "type": "object", "properties": { "preservedState": { "$ref": "StatefulPolicyPreservedState" } } }, "StatefulPolicyPreservedState": { "id": "StatefulPolicyPreservedState", "description": "Configuration of preserved resources.", "type": "object", "properties": { "disks": { "description": "Disks created on the instances that will be preserved on instance delete, update, etc. This map is keyed with the device names of the disks.", "type": "object", "additionalProperties": { "$ref": "StatefulPolicyPreservedStateDiskDevice" } }, "internalIPs": { "description": "Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.", "type": "object", "additionalProperties": { "$ref": "StatefulPolicyPreservedStateNetworkIp" } }, "externalIPs": { "description": "External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name.", "type": "object", "additionalProperties": { "$ref": "StatefulPolicyPreservedStateNetworkIp" } } } }, "StatefulPolicyPreservedStateDiskDevice": { "id": "StatefulPolicyPreservedStateDiskDevice", "type": "object", "properties": { "autoDelete": { "description": "These stateful disks will never be deleted during autohealing, update or VM instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NEVER", "ON_PERMANENT_INSTANCE_DELETION" ] } } }, "StatefulPolicyPreservedStateNetworkIp": { "id": "StatefulPolicyPreservedStateNetworkIp", "type": "object", "properties": { "autoDelete": { "description": "These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NEVER", "ON_PERMANENT_INSTANCE_DELETION" ] } } }, "InstanceGroupManagerInstanceLifecyclePolicy": { "id": "InstanceGroupManagerInstanceLifecyclePolicy", "type": "object", "properties": { "forceUpdateOnRepair": { "description": "A bit indicating whether to forcefully apply the group's latest configuration when repairing a VM. Valid options are: - NO (default): If configuration updates are available, they are not forcefully applied during repair. Instead, configuration updates are applied according to the group's update policy. - YES: If configuration updates are available, they are applied during repair. ", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NO", "YES" ] }, "defaultActionOnFailure": { "description": "The action that a MIG performs on a failed or an unhealthy VM. A VM is marked as unhealthy when the application running on that VM fails a health check. Valid values are - REPAIR (default): MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG. - DO_NOTHING: MIG does not repair a failed or an unhealthy VM. ", "type": "string", "enumDescriptions": [ "MIG does not repair a failed or an unhealthy VM.", "(Default) MIG automatically repairs a failed or an unhealthy VM by recreating it. For more information, see About repairing VMs in a MIG." ], "enum": [ "DO_NOTHING", "REPAIR" ] } } }, "InstanceGroupManagerAggregatedList": { "id": "InstanceGroupManagerAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.", "default": "compute#instanceGroupManagerAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InstanceGroupManagersScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] The name of the scope that contains this set of managed instance groups.", "$ref": "InstanceGroupManagersScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "InstanceGroupManagersScopedList": { "id": "InstanceGroupManagersScopedList", "type": "object", "properties": { "instanceGroupManagers": { "description": "[Output Only] The list of managed instance groups that are contained in the specified project and zone.", "type": "array", "items": { "$ref": "InstanceGroupManager" } }, "warning": { "description": "[Output Only] The warning that replaces the list of managed instance groups when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InstanceGroupManagersDeleteInstancesRequest": { "id": "InstanceGroupManagersDeleteInstancesRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME]. Queued instances do not have URL and can be deleted only by name. One cannot specify both URLs and names in a single request.", "type": "array", "items": { "type": "string" } }, "skipInstancesOnValidationError": { "description": "Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.", "type": "boolean" } } }, "InstanceGroupManagersSuspendInstancesRequest": { "id": "InstanceGroupManagersSuspendInstancesRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to suspend. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } }, "forceSuspend": { "description": "If this flag is set to true, the Instance Group Manager will proceed to suspend the instances, skipping initialization on them.", "type": "boolean" } } }, "InstanceGroupManagersResumeInstancesRequest": { "id": "InstanceGroupManagersResumeInstancesRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to resume. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } } } }, "InstanceGroupManagersStopInstancesRequest": { "id": "InstanceGroupManagersStopInstancesRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to stop. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } }, "forceStop": { "description": "If this flag is set to true, the Instance Group Manager will proceed to stop the instances, skipping initialization on them.", "type": "boolean" } } }, "InstanceGroupManagersStartInstancesRequest": { "id": "InstanceGroupManagersStartInstancesRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to start. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } } } }, "InstanceGroupManagersAbandonInstancesRequest": { "id": "InstanceGroupManagersAbandonInstancesRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } } } }, "InstanceGroupManagersRecreateInstancesRequest": { "id": "InstanceGroupManagersRecreateInstancesRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } } } }, "InstanceGroupManagersSetInstanceTemplateRequest": { "id": "InstanceGroupManagersSetInstanceTemplateRequest", "type": "object", "properties": { "instanceTemplate": { "description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.", "type": "string" } } }, "InstanceGroupManagersSetTargetPoolsRequest": { "id": "InstanceGroupManagersSetTargetPoolsRequest", "type": "object", "properties": { "targetPools": { "description": "The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.", "type": "array", "items": { "type": "string" } }, "fingerprint": { "description": "The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.", "type": "string", "format": "byte" } } }, "InstanceGroupManagersListManagedInstancesResponse": { "id": "InstanceGroupManagersListManagedInstancesResponse", "type": "object", "properties": { "managedInstances": { "description": "[Output Only] The list of instances in the managed instance group.", "type": "array", "items": { "$ref": "ManagedInstance" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" } } }, "ManagedInstance": { "id": "ManagedInstance", "description": "A Managed Instance resource.", "type": "object", "properties": { "name": { "description": "[Output Only] The name of the instance. The name always exists even if the instance has not yet been created.", "type": "string" }, "instance": { "description": "[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.", "type": "string" }, "id": { "description": "[Output only] The unique identifier for this resource. This field is empty when instance does not exist.", "type": "string", "format": "uint64" }, "instanceStatus": { "description": "[Output Only] The status of the instance. This field is empty when the instance does not exist.", "type": "string", "enumDescriptions": [ "The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.", "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 is 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 failure)." ], "enum": [ "DEPROVISIONING", "PROVISIONING", "REPAIRING", "RUNNING", "STAGING", "STOPPED", "STOPPING", "SUSPENDED", "SUSPENDING", "TERMINATED" ] }, "version": { "description": "[Output Only] Intended version of this instance.", "$ref": "ManagedInstanceVersion" }, "preservedStateFromPolicy": { "description": "[Output Only] Preserved state generated based on stateful policy for this instance.", "$ref": "PreservedState" }, "preservedStateFromConfig": { "description": "[Output Only] Preserved state applied from per-instance config for this instance.", "$ref": "PreservedState" }, "currentAction": { "description": "[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. ", "type": "string", "enumDescriptions": [ "The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.", "The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.", "The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased.", "The managed instance group is permanently deleting this instance.", "The managed instance group has not scheduled any actions for this instance.", "The managed instance group is recreating this instance.", "The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.", "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. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group's autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions)." ], "enum": [ "ABANDONING", "CREATING", "CREATING_WITHOUT_RETRIES", "DELETING", "NONE", "RECREATING", "REFRESHING", "RESTARTING", "RESUMING", "STARTING", "STOPPING", "SUSPENDING", "VERIFYING" ] }, "instanceHealth": { "description": "[Output Only] Health state of the instance per health-check.", "type": "array", "items": { "$ref": "ManagedInstanceInstanceHealth" } }, "lastAttempt": { "description": "[Output Only] Information about the last attempt to create or delete the instance.", "$ref": "ManagedInstanceLastAttempt" }, "propertiesFromFlexibilityPolicy": { "description": "[Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy.", "$ref": "ManagedInstancePropertiesFromFlexibilityPolicy" } } }, "ManagedInstanceVersion": { "id": "ManagedInstanceVersion", "type": "object", "properties": { "name": { "description": "[Output Only] Name of the version.", "type": "string" }, "instanceTemplate": { "description": "[Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.", "type": "string" } } }, "PreservedState": { "id": "PreservedState", "description": "Preserved state for a given instance.", "type": "object", "properties": { "disks": { "description": "Preserved disks defined for this instance. This map is keyed with the device names of the disks.", "type": "object", "additionalProperties": { "$ref": "PreservedStatePreservedDisk" } }, "metadata": { "description": "Preserved metadata defined for this instance.", "type": "object", "additionalProperties": { "type": "string" } }, "internalIPs": { "description": "Preserved internal IPs defined for this instance. This map is keyed with the name of the network interface.", "type": "object", "additionalProperties": { "$ref": "PreservedStatePreservedNetworkIp" } }, "externalIPs": { "description": "Preserved external IPs defined for this instance. This map is keyed with the name of the network interface.", "type": "object", "additionalProperties": { "$ref": "PreservedStatePreservedNetworkIp" } } } }, "PreservedStatePreservedDisk": { "id": "PreservedStatePreservedDisk", "type": "object", "properties": { "source": { "description": "The URL of the disk resource that is stateful and should be attached to the VM instance.", "type": "string" }, "mode": { "description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.", "type": "string", "enumDescriptions": [ "Attaches this disk in read-only mode. Multiple VM instances can use a disk in READ_ONLY mode at a time.", "[Default] Attaches this disk in READ_WRITE mode. Only one VM instance at a time can be attached to a disk in READ_WRITE mode." ], "enum": [ "READ_ONLY", "READ_WRITE" ] }, "autoDelete": { "description": "These stateful disks will never be deleted during autohealing, update, instance recreate operations. This flag is used to configure if the disk should be deleted after it is no longer used by the group, e.g. when the given instance or the whole MIG is deleted. Note: disks attached in READ_ONLY mode cannot be auto-deleted.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NEVER", "ON_PERMANENT_INSTANCE_DELETION" ] } } }, "PreservedStatePreservedNetworkIp": { "id": "PreservedStatePreservedNetworkIp", "type": "object", "properties": { "autoDelete": { "description": "These stateful IPs will never be released during autohealing, update or VM instance recreate operations. This flag is used to configure if the IP reservation should be deleted after it is no longer used by the group, e.g. when the given instance or the whole group is deleted.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NEVER", "ON_PERMANENT_INSTANCE_DELETION" ] }, "ipAddress": { "description": "Ip address representation", "$ref": "PreservedStatePreservedNetworkIpIpAddress" } } }, "PreservedStatePreservedNetworkIpIpAddress": { "id": "PreservedStatePreservedNetworkIpIpAddress", "type": "object", "properties": { "literal": { "description": "An IPv4 internal network address to assign to the instance for this network interface.", "type": "string" }, "address": { "description": "The URL of the reservation for this IP address.", "type": "string" } } }, "ManagedInstanceInstanceHealth": { "id": "ManagedInstanceInstanceHealth", "type": "object", "properties": { "healthCheck": { "description": "[Output Only] The URL for the health check that verifies whether the instance is healthy.", "type": "string" }, "detailedHealthState": { "description": "[Output Only] The current detailed instance health state.", "type": "string", "enumDescriptions": [ "The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused.", "The instance is reachable i.e. a connection to the application health checking endpoint can be established, and conforms to the requirements defined by the health check.", "The instance is unreachable i.e. a connection to the application health checking endpoint cannot be established, or the server does not respond within the specified timeout.", "The instance is reachable, but does not conform to the requirements defined by the health check.", "The health checking system is aware of the instance but its health is not known at the moment." ], "enum": [ "DRAINING", "HEALTHY", "TIMEOUT", "UNHEALTHY", "UNKNOWN" ] } } }, "ManagedInstanceLastAttempt": { "id": "ManagedInstanceLastAttempt", "type": "object", "properties": { "errors": { "description": "[Output Only] Encountered errors during the last attempt to create or delete the instance.", "type": "object", "properties": { "errors": { "description": "[Output Only] The array of errors encountered while processing this operation.", "type": "array", "items": { "type": "object", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", "type": "string" }, "location": { "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", "type": "string" }, "message": { "description": "[Output Only] An optional, human-readable error message.", "type": "string" }, "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", "type": "array", "items": { "type": "object", "properties": { "errorInfo": { "$ref": "ErrorInfo" }, "quotaInfo": { "$ref": "QuotaExceededInfo" }, "help": { "$ref": "Help" }, "localizedMessage": { "$ref": "LocalizedMessage" } } } } } } } } } } }, "ManagedInstancePropertiesFromFlexibilityPolicy": { "id": "ManagedInstancePropertiesFromFlexibilityPolicy", "type": "object", "properties": { "machineType": { "description": "The machine type to be used for this instance.", "type": "string" } } }, "InstanceGroupManagersListErrorsResponse": { "id": "InstanceGroupManagersListErrorsResponse", "type": "object", "properties": { "items": { "description": "[Output Only] The list of errors of the managed instance group.", "type": "array", "items": { "$ref": "InstanceManagedByIgmError" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" } } }, "InstanceManagedByIgmError": { "id": "InstanceManagedByIgmError", "type": "object", "properties": { "error": { "description": "[Output Only] Contents of the error.", "$ref": "InstanceManagedByIgmErrorManagedInstanceError" }, "timestamp": { "description": "[Output Only] The time that this error occurred. This value is in RFC3339 text format.", "type": "string" }, "instanceActionDetails": { "description": "[Output Only] Details of the instance action that triggered this error. May be null, if the error was not caused by an action on an instance. This field is optional.", "$ref": "InstanceManagedByIgmErrorInstanceActionDetails" } } }, "InstanceManagedByIgmErrorManagedInstanceError": { "id": "InstanceManagedByIgmErrorManagedInstanceError", "type": "object", "properties": { "code": { "description": "[Output Only] Error code.", "type": "string" }, "message": { "description": "[Output Only] Error message.", "type": "string" } } }, "InstanceManagedByIgmErrorInstanceActionDetails": { "id": "InstanceManagedByIgmErrorInstanceActionDetails", "type": "object", "properties": { "action": { "description": "[Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:", "type": "string", "enumDescriptions": [ "The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group.", "The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful.", "The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased.", "The managed instance group is permanently deleting this instance.", "The managed instance group has not scheduled any actions for this instance.", "The managed instance group is recreating this instance.", "The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.", "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. Verification happens every time the instance is (re)created or restarted and consists of: 1. Waiting until health check specified as part of this managed instance group's autohealing policy reports HEALTHY. Note: Applies only if autohealing policy has a health check specified 2. Waiting for addition verification steps performed as post-instance creation (subject to future extensions)." ], "enum": [ "ABANDONING", "CREATING", "CREATING_WITHOUT_RETRIES", "DELETING", "NONE", "RECREATING", "REFRESHING", "RESTARTING", "RESUMING", "STARTING", "STOPPING", "SUSPENDING", "VERIFYING" ] }, "instance": { "description": "[Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created.", "type": "string" }, "version": { "description": "[Output Only] Version this instance was created from, or was being created from, but the creation failed. Corresponds to one of the versions that were set on the Instance Group Manager resource at the time this instance was being created.", "$ref": "ManagedInstanceVersion" } } }, "InstanceGroupManagersListPerInstanceConfigsResp": { "id": "InstanceGroupManagersListPerInstanceConfigsResp", "type": "object", "properties": { "items": { "description": "[Output Only] The list of PerInstanceConfig.", "type": "array", "items": { "$ref": "PerInstanceConfig" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "PerInstanceConfig": { "id": "PerInstanceConfig", "type": "object", "properties": { "name": { "description": "The name of a per-instance configuration and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance configuration with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance configuration for a VM instance that either doesn't exist or is not part of the group will result in an error.", "type": "string" }, "preservedState": { "description": "The intended preserved state for the given instance. Does not contain preserved state generated from a stateful policy.", "$ref": "PreservedState" }, "status": { "description": "The status of applying this per-instance configuration on the corresponding managed instance.", "type": "string", "enumDescriptions": [ "The per-instance configuration is being applied to the instance, but is not yet effective, possibly waiting for the instance to, for example, REFRESH.", "The per-instance configuration deletion is being applied on the instance, possibly waiting for the instance to, for example, REFRESH.", "The per-instance configuration is effective on the instance, meaning that all disks, ips and metadata specified in this configuration are attached or set on the instance.", "[Default] The default status, when no per-instance configuration exists.", "The per-instance configuration is set on an instance but not been applied yet.", "The per-instance configuration has been deleted, but the deletion is not yet applied." ], "enum": [ "APPLYING", "DELETING", "EFFECTIVE", "NONE", "UNAPPLIED", "UNAPPLIED_DELETION" ] }, "fingerprint": { "description": "Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance configuration or the field needs to be unset.", "type": "string", "format": "byte" } } }, "InstanceGroupManagersUpdatePerInstanceConfigsReq": { "id": "InstanceGroupManagersUpdatePerInstanceConfigsReq", "description": "InstanceGroupManagers.updatePerInstanceConfigs", "type": "object", "properties": { "perInstanceConfigs": { "description": "The list of per-instance configurations to insert or patch on this managed instance group.", "type": "array", "items": { "$ref": "PerInstanceConfig" } } } }, "InstanceGroupManagersPatchPerInstanceConfigsReq": { "id": "InstanceGroupManagersPatchPerInstanceConfigsReq", "description": "InstanceGroupManagers.patchPerInstanceConfigs", "type": "object", "properties": { "perInstanceConfigs": { "description": "The list of per-instance configurations to insert or patch on this managed instance group.", "type": "array", "items": { "$ref": "PerInstanceConfig" } } } }, "InstanceGroupManagersDeletePerInstanceConfigsReq": { "id": "InstanceGroupManagersDeletePerInstanceConfigsReq", "description": "InstanceGroupManagers.deletePerInstanceConfigs", "type": "object", "properties": { "names": { "description": "The list of instance names for which we want to delete per-instance configs on this managed instance group.", "type": "array", "items": { "type": "string" } } } }, "InstanceGroupManagersApplyUpdatesRequest": { "id": "InstanceGroupManagersApplyUpdatesRequest", "description": "InstanceGroupManagers.applyUpdatesToInstances", "type": "object", "properties": { "instances": { "description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } }, "minimalAction": { "description": "The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.", "type": "string", "enumDescriptions": [ "Do not perform any action.", "Do not stop the instance.", "(Default.) Replace the instance according to the replacement method option.", "Stop the instance and start it again." ], "enum": [ "NONE", "REFRESH", "REPLACE", "RESTART" ] }, "mostDisruptiveAllowedAction": { "description": "The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.", "type": "string", "enumDescriptions": [ "Do not perform any action.", "Do not stop the instance.", "(Default.) Replace the instance according to the replacement method option.", "Stop the instance and start it again." ], "enum": [ "NONE", "REFRESH", "REPLACE", "RESTART" ] }, "allInstances": { "description": "Flag to update all instances instead of specified list of \u201Cinstances\u201D. If the flag is set to true then the instances may not be specified in the request.", "type": "boolean" } } }, "InstanceGroupManagersCreateInstancesRequest": { "id": "InstanceGroupManagersCreateInstancesRequest", "description": "InstanceGroupManagers.createInstances", "type": "object", "properties": { "instances": { "description": "[Required] List of specifications of per-instance configs.", "type": "array", "items": { "$ref": "PerInstanceConfig" } } } }, "InstanceGroupManagerResizeRequest": { "id": "InstanceGroupManagerResizeRequest", "description": "InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.", "default": "compute#instanceGroupManagerResizeRequest", "type": "string" }, "id": { "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] The creation timestamp for this resize request in RFC3339 text format.", "type": "string" }, "name": { "description": "The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.instanceGroupManagerResizeRequests.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource.", "type": "string" }, "zone": { "description": "[Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.", "type": "string" }, "resizeBy": { "description": "The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'.", "type": "integer", "format": "int32" }, "requestedRunDuration": { "description": "Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.", "$ref": "Duration" }, "state": { "description": "[Output only] Current state of the request.", "type": "string", "enumDescriptions": [ "The request was created successfully and was accepted for provisioning when 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 during provisioning, any VMs that were created during provisioning are rolled back and removed from the MIG.", "Default value. This value should never be returned.", "The request succeeded." ], "enum": [ "ACCEPTED", "CANCELLED", "CREATING", "FAILED", "STATE_UNSPECIFIED", "SUCCEEDED" ] }, "status": { "description": "[Output only] Status of the request.", "$ref": "InstanceGroupManagerResizeRequestStatus" }, "selfLink": { "description": "[Output Only] The URL for this resize request. The server defines this URL.", "type": "string" }, "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" } } }, "InstanceGroupManagerResizeRequestStatus": { "id": "InstanceGroupManagerResizeRequestStatus", "type": "object", "properties": { "error": { "description": "[Output only] Fatal errors encountered during the queueing or provisioning phases of the ResizeRequest that caused the transition to the FAILED state. Contrary to the last_attempt errors, this field is final and errors are never removed from here, as the ResizeRequest is not going to retry.", "type": "object", "properties": { "errors": { "description": "[Output Only] The array of errors encountered while processing this operation.", "type": "array", "items": { "type": "object", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", "type": "string" }, "location": { "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", "type": "string" }, "message": { "description": "[Output Only] An optional, human-readable error message.", "type": "string" }, "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", "type": "array", "items": { "type": "object", "properties": { "errorInfo": { "$ref": "ErrorInfo" }, "quotaInfo": { "$ref": "QuotaExceededInfo" }, "help": { "$ref": "Help" }, "localizedMessage": { "$ref": "LocalizedMessage" } } } } } } } } }, "lastAttempt": { "description": "[Output only] Information about the last attempt to fulfill the request. The value is temporary since the ResizeRequest can retry, as long as it's still active and the last attempt value can either be cleared or replaced with a different error. Since ResizeRequest retries infrequently, the value may be stale and no longer show an active problem. The value is cleared when ResizeRequest transitions to the final state (becomes inactive). If the final state is FAILED the error describing it will be storred in the \"error\" field only.", "$ref": "InstanceGroupManagerResizeRequestStatusLastAttempt" } } }, "InstanceGroupManagerResizeRequestStatusLastAttempt": { "id": "InstanceGroupManagerResizeRequestStatusLastAttempt", "type": "object", "properties": { "error": { "description": "Errors that prevented the ResizeRequest to be fulfilled.", "type": "object", "properties": { "errors": { "description": "[Output Only] The array of errors encountered while processing this operation.", "type": "array", "items": { "type": "object", "properties": { "code": { "description": "[Output Only] The error type identifier for this error.", "type": "string" }, "location": { "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", "type": "string" }, "message": { "description": "[Output Only] An optional, human-readable error message.", "type": "string" }, "errorDetails": { "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", "type": "array", "items": { "type": "object", "properties": { "errorInfo": { "$ref": "ErrorInfo" }, "quotaInfo": { "$ref": "QuotaExceededInfo" }, "help": { "$ref": "Help" }, "localizedMessage": { "$ref": "LocalizedMessage" } } } } } } } } } } }, "InstanceGroupManagerResizeRequestsListResponse": { "id": "InstanceGroupManagerResizeRequestsListResponse", "description": "[Output Only] A list of resize requests.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#instanceGroupManagerResizeRequestList for a list of resize requests.", "default": "compute#instanceGroupManagerResizeRequestList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of resize request resources.", "type": "array", "items": { "$ref": "InstanceGroupManagerResizeRequest" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "RegionInstanceGroupManagerList": { "id": "RegionInstanceGroupManagerList", "description": "Contains a list of managed instance groups.", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.", "default": "compute#regionInstanceGroupManagerList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InstanceGroupManager resources.", "type": "array", "items": { "$ref": "InstanceGroupManager" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "RegionInstanceGroupManagersDeleteInstancesRequest": { "id": "RegionInstanceGroupManagersDeleteInstancesRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } }, "skipInstancesOnValidationError": { "description": "Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.", "type": "boolean" } } }, "RegionInstanceGroupManagersSuspendInstancesRequest": { "id": "RegionInstanceGroupManagersSuspendInstancesRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to suspend. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } }, "forceSuspend": { "description": "If this flag is set to true, the Instance Group Manager will proceed to suspend the instances, skipping initialization on them.", "type": "boolean" } } }, "RegionInstanceGroupManagersResumeInstancesRequest": { "id": "RegionInstanceGroupManagersResumeInstancesRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to resume. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } } } }, "RegionInstanceGroupManagersStopInstancesRequest": { "id": "RegionInstanceGroupManagersStopInstancesRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to stop. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } }, "forceStop": { "description": "If this flag is set to true, the Instance Group Manager will proceed to stop the instances, skipping initialization on them.", "type": "boolean" } } }, "RegionInstanceGroupManagersStartInstancesRequest": { "id": "RegionInstanceGroupManagersStartInstancesRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to start. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } } } }, "RegionInstanceGroupManagersAbandonInstancesRequest": { "id": "RegionInstanceGroupManagersAbandonInstancesRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } } } }, "RegionInstanceGroupManagersRecreateRequest": { "id": "RegionInstanceGroupManagersRecreateRequest", "type": "object", "properties": { "instances": { "description": "The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } } } }, "RegionInstanceGroupManagersSetTemplateRequest": { "id": "RegionInstanceGroupManagersSetTemplateRequest", "type": "object", "properties": { "instanceTemplate": { "description": "URL of the InstanceTemplate resource from which all new instances will be created.", "type": "string" } } }, "RegionInstanceGroupManagersSetTargetPoolsRequest": { "id": "RegionInstanceGroupManagersSetTargetPoolsRequest", "type": "object", "properties": { "targetPools": { "description": "The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.", "type": "array", "items": { "type": "string" } }, "fingerprint": { "description": "Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.", "type": "string", "format": "byte" } } }, "RegionInstanceGroupManagersListInstancesResponse": { "id": "RegionInstanceGroupManagersListInstancesResponse", "type": "object", "properties": { "managedInstances": { "description": "A list of managed instances.", "type": "array", "items": { "$ref": "ManagedInstance" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" } } }, "RegionInstanceGroupManagersListErrorsResponse": { "id": "RegionInstanceGroupManagersListErrorsResponse", "type": "object", "properties": { "items": { "description": "[Output Only] The list of errors of the managed instance group.", "type": "array", "items": { "$ref": "InstanceManagedByIgmError" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" } } }, "RegionInstanceGroupManagersListInstanceConfigsResp": { "id": "RegionInstanceGroupManagersListInstanceConfigsResp", "type": "object", "properties": { "items": { "description": "[Output Only] The list of PerInstanceConfig.", "type": "array", "items": { "$ref": "PerInstanceConfig" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "RegionInstanceGroupManagerUpdateInstanceConfigReq": { "id": "RegionInstanceGroupManagerUpdateInstanceConfigReq", "description": "RegionInstanceGroupManagers.updatePerInstanceConfigs", "type": "object", "properties": { "perInstanceConfigs": { "description": "The list of per-instance configurations to insert or patch on this managed instance group.", "type": "array", "items": { "$ref": "PerInstanceConfig" } } } }, "RegionInstanceGroupManagerPatchInstanceConfigReq": { "id": "RegionInstanceGroupManagerPatchInstanceConfigReq", "description": "RegionInstanceGroupManagers.patchPerInstanceConfigs", "type": "object", "properties": { "perInstanceConfigs": { "description": "The list of per-instance configurations to insert or patch on this managed instance group.", "type": "array", "items": { "$ref": "PerInstanceConfig" } } } }, "RegionInstanceGroupManagerDeleteInstanceConfigReq": { "id": "RegionInstanceGroupManagerDeleteInstanceConfigReq", "description": "RegionInstanceGroupManagers.deletePerInstanceConfigs", "type": "object", "properties": { "names": { "description": "The list of instance names for which we want to delete per-instance configs on this managed instance group.", "type": "array", "items": { "type": "string" } } } }, "RegionInstanceGroupManagersApplyUpdatesRequest": { "id": "RegionInstanceGroupManagersApplyUpdatesRequest", "description": "RegionInstanceGroupManagers.applyUpdatesToInstances", "type": "object", "properties": { "instances": { "description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones\/[ZONE]\/instances\/[INSTANCE_NAME].", "type": "array", "items": { "type": "string" } }, "minimalAction": { "description": "The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.", "type": "string", "enumDescriptions": [ "Do not perform any action.", "Do not stop the instance.", "(Default.) Replace the instance according to the replacement method option.", "Stop the instance and start it again." ], "enum": [ "NONE", "REFRESH", "REPLACE", "RESTART" ] }, "mostDisruptiveAllowedAction": { "description": "The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance and limit disruption as much as possible. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.", "type": "string", "enumDescriptions": [ "Do not perform any action.", "Do not stop the instance.", "(Default.) Replace the instance according to the replacement method option.", "Stop the instance and start it again." ], "enum": [ "NONE", "REFRESH", "REPLACE", "RESTART" ] }, "allInstances": { "description": "Flag to update all instances instead of specified list of \u201Cinstances\u201D. If the flag is set to true then the instances may not be specified in the request.", "type": "boolean" } } }, "RegionInstanceGroupManagersCreateInstancesRequest": { "id": "RegionInstanceGroupManagersCreateInstancesRequest", "description": "RegionInstanceGroupManagers.createInstances", "type": "object", "properties": { "instances": { "description": "[Required] List of specifications of per-instance configs.", "type": "array", "items": { "$ref": "PerInstanceConfig" } } } }, "AutoscalerList": { "id": "AutoscalerList", "description": "Contains a list of Autoscaler resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.", "default": "compute#autoscalerList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Autoscaler resources.", "type": "array", "items": { "$ref": "Autoscaler" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Autoscaler": { "id": "Autoscaler", "description": "Represents an Autoscaler resource. Google Compute Engine has two Autoscaler resources: * [Zonal](\/compute\/docs\/reference\/rest\/v2\/autoscalers) * [Regional](\/compute\/docs\/reference\/rest\/v2\/regionAutoscalers) Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.", "default": "compute#autoscaler", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.autoscalers.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "target": { "description": "URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler.", "type": "string" }, "autoscalingPolicy": { "description": "The configuration parameters for the autoscaling algorithm. You can define one or more signals for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%.", "$ref": "AutoscalingPolicy" }, "zone": { "description": "[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "status": { "description": "[Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new\/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.", "type": "string", "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" ], "enum": [ "ACTIVE", "DELETING", "ERROR", "PENDING" ] }, "statusDetails": { "description": "[Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.", "type": "array", "items": { "$ref": "AutoscalerStatusDetails" } }, "recommendedSize": { "description": "[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction.", "type": "integer", "format": "int32" }, "scalingScheduleStatus": { "description": "[Output Only] Status information of existing scaling schedules.", "type": "object", "additionalProperties": { "$ref": "ScalingScheduleStatus" } } } }, "AutoscalingPolicy": { "id": "AutoscalingPolicy", "description": "Cloud Autoscaler policy.", "type": "object", "properties": { "minNumReplicas": { "description": "The minimum number of replicas that the autoscaler can scale in to. This cannot be less than 0. If not provided, autoscaler chooses a default value depending on maximum number of instances allowed.", "type": "integer", "format": "int32" }, "maxNumReplicas": { "description": "The maximum number of instances that the autoscaler can scale out to. This is required when creating or updating an autoscaler. The maximum number of replicas must not be lower than minimal number of replicas.", "type": "integer", "format": "int32" }, "scaleInControl": { "$ref": "AutoscalingPolicyScaleInControl" }, "coolDownPeriodSec": { "description": "The number of seconds that your application takes to initialize on a VM instance. This is referred to as the [initialization period](\/compute\/docs\/autoscaler#cool_down_period). Specifying an accurate initialization period improves autoscaler decisions. For example, when scaling out, the autoscaler ignores data from VMs that are still initializing because those VMs might not yet represent normal usage of your application. The default initialization period is 60 seconds. Initialization periods might vary because of numerous factors. We recommend that you test how long your application takes to initialize. To do this, create a VM and time your application's startup process.", "type": "integer", "format": "int32" }, "cpuUtilization": { "description": "Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group.", "$ref": "AutoscalingPolicyCpuUtilization" }, "customMetricUtilizations": { "description": "Configuration parameters of autoscaling based on a custom metric.", "type": "array", "items": { "$ref": "AutoscalingPolicyCustomMetricUtilization" } }, "loadBalancingUtilization": { "description": "Configuration parameters of autoscaling based on load balancer.", "$ref": "AutoscalingPolicyLoadBalancingUtilization" }, "mode": { "description": "Defines the operating mode for this policy. The following modes are available: - OFF: Disables the autoscaler but maintains its configuration. - ONLY_SCALE_OUT: Restricts the autoscaler to add VM instances only. - ON: Enables all autoscaler activities according to its policy. For more information, see \"Turning off or restricting an autoscaler\"", "type": "string", "enumDescriptions": [ "Do not automatically scale the MIG in or out. The recommended_size field contains the size of MIG that would be set if the 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 the MIG in.", "Automatically create VMs according to the policy, but do not scale the MIG in." ], "enum": [ "OFF", "ON", "ONLY_SCALE_OUT", "ONLY_UP" ] }, "scalingSchedules": { "description": "Scaling schedules defined for an autoscaler. Multiple schedules can be set on an autoscaler, and they can overlap. During overlapping periods the greatest min_required_replicas of all scaling schedules is applied. Up to 128 scaling schedules are allowed.", "type": "object", "additionalProperties": { "$ref": "AutoscalingPolicyScalingSchedule" } } } }, "AutoscalingPolicyScaleInControl": { "id": "AutoscalingPolicyScaleInControl", "description": "Configuration that allows for slower scale in so that even if Autoscaler recommends an abrupt scale in of a MIG, it will be throttled as specified by the parameters below.", "type": "object", "properties": { "maxScaledInReplicas": { "description": "Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step.", "$ref": "FixedOrPercent" }, "timeWindowSec": { "description": "How far back autoscaling looks when computing recommendations to include directives regarding slower scale in, as described above.", "type": "integer", "format": "int32" } } }, "AutoscalingPolicyCpuUtilization": { "id": "AutoscalingPolicyCpuUtilization", "description": "CPU utilization policy.", "type": "object", "properties": { "utilizationTarget": { "description": "The target CPU utilization that the autoscaler maintains. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales in the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales out until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.", "type": "number", "format": "double" }, "predictiveMethod": { "description": "Indicates whether predictive autoscaling based on CPU metric is enabled. Valid values are: NONE (default). No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics. * OPTIMIZE_AVAILABILITY. Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand.", "type": "string", "enumDescriptions": [ "No predictive method is used. The autoscaler scales the group to meet current demand based on real-time metrics", "Predictive autoscaling improves availability by monitoring daily and weekly load patterns and scaling out ahead of anticipated demand." ], "enum": [ "NONE", "OPTIMIZE_AVAILABILITY" ] } } }, "AutoscalingPolicyCustomMetricUtilization": { "id": "AutoscalingPolicyCustomMetricUtilization", "description": "Custom utilization metric policy.", "type": "object", "properties": { "utilizationTarget": { "description": "The target value of the metric that autoscaler maintains. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric. For example, a good metric to use as a utilization_target is https:\/\/www.googleapis.com\/compute\/v1\/instance\/network\/received_bytes_count. The autoscaler works to keep this value constant for each of the instances.", "type": "number", "format": "double" }, "singleInstanceAssignment": { "description": "If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. Autoscaler keeps the number of instances proportional to the value of this metric. The metric itself does not change value due to group resizing. A good metric to use with the target is for example pubsub.googleapis.com\/subscription\/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can't include a chunk assignable to a single instance, it could be better used with utilization_target instead.", "type": "number", "format": "double" }, "metric": { "description": "The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE.", "type": "string" }, "filter": { "description": "A filter string, compatible with a Stackdriver Monitoring filter string for TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. For the filter to be valid for autoscaling purposes, the following rules apply: - You can only use the AND operator for joining selectors. - You can only use direct equality comparison operator (=) without any functions for each selector. - You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. - The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling. If not specified, the type defaults to gce_instance. Try to provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gce_instance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.", "type": "string" }, "utilizationTargetType": { "description": "Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.", "type": "string", "enumDescriptions": [ "Sets the utilization target value for a cumulative or delta metric, expressed as the rate of growth per minute.", "Sets the utilization target value for a cumulative or delta metric, expressed as the rate of growth per second.", "Sets the utilization target value for a gauge metric. The autoscaler will collect the average utilization of the virtual machines from the last couple of minutes, and compare the value to the utilization target value to perform autoscaling." ], "enum": [ "DELTA_PER_MINUTE", "DELTA_PER_SECOND", "GAUGE" ] } } }, "AutoscalingPolicyLoadBalancingUtilization": { "id": "AutoscalingPolicyLoadBalancingUtilization", "description": "Configuration parameters of autoscaling based on load balancing.", "type": "object", "properties": { "utilizationTarget": { "description": "Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that the autoscaler maintains. Must be a positive float value. If not defined, the default is 0.8.", "type": "number", "format": "double" } } }, "AutoscalingPolicyScalingSchedule": { "id": "AutoscalingPolicyScalingSchedule", "description": "Scaling based on user-defined schedule. The message describes a single scaling schedule. A scaling schedule changes the minimum number of VM instances an autoscaler can recommend, which can trigger scaling out.", "type": "object", "properties": { "minRequiredReplicas": { "description": "The minimum number of VM instances that the autoscaler will recommend in time intervals starting according to schedule. This field is required.", "type": "integer", "format": "int32" }, "schedule": { "description": "The start timestamps of time intervals when this scaling schedule is to provide a scaling signal. This field uses the extended cron format (with an optional year field). The expression can describe a single timestamp if the optional year is set, in which case the scaling schedule runs once. The schedule is interpreted with respect to time_zone. This field is required. Note: These timestamps only describe when autoscaler starts providing the scaling signal. The VMs need additional time to become serving.", "type": "string" }, "timeZone": { "description": "The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https:\/\/en.wikipedia.org\/wiki\/Tz_database. This field is assigned a default value of \"UTC\" if left empty.", "type": "string" }, "durationSec": { "description": "The duration of time intervals, in seconds, for which this scaling schedule is to run. The minimum allowed value is 300. This field is required.", "type": "integer", "format": "int32" }, "disabled": { "description": "A boolean value that specifies whether a scaling schedule can influence autoscaler recommendations. If set to true, then a scaling schedule has no effect. This field is optional, and its value is false by default.", "type": "boolean" }, "description": { "description": "A description of a scaling schedule.", "type": "string" } } }, "AutoscalerStatusDetails": { "id": "AutoscalerStatusDetails", "type": "object", "properties": { "message": { "description": "The status message.", "type": "string" }, "type": { "description": "The type of error, warning, or notice returned. Current set of possible values: - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. - MODE_ONLY_UP (WARNING): Autoscaling is in the \"Autoscale only out\" mode. The autoscaler can add instances but not remove any. - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP\/S load balancer that has been configured for maxRate. - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.", "type": "string", "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 base for autoscaling.", "The custom metric that was specified does not exist or does not have the necessary labels.", "The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group.", "The autoscaler did not receive any data from the custom metric configured for autoscaling.", "The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer.", "Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved.", "Autoscaling is in the \"Autoscale only scale out\" mode. Instances in the group will be only added.", "Autoscaling is in the \"Autoscale only out\" mode. Instances in the group will be only added.", "The instance group cannot be autoscaled because it has more than one backend service attached to it.", "There is insufficient quota for the necessary resources, such as CPU or number of instances.", "Showed only for regional autoscalers: there is a resource stockout in the chosen region.", "The target to be scaled does not exist.", "For some scaling schedules minRequiredReplicas is greater than maxNumReplicas. Autoscaler always recommends at most maxNumReplicas instances.", "For some scaling schedules minRequiredReplicas is less than minNumReplicas. Autoscaler always recommends at least minNumReplicas instances.", "", "Autoscaling does not work with an HTTP\/S load balancer that has been configured for maxRate.", "For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout." ], "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" ] } } }, "ScalingScheduleStatus": { "id": "ScalingScheduleStatus", "type": "object", "properties": { "nextStartTime": { "description": "[Output Only] The next time the scaling schedule is to become active. Note: this is a timestamp when a schedule is planned to run, but the actual time might be slightly different. The timestamp is in RFC3339 text format.", "type": "string" }, "lastStartTime": { "description": "[Output Only] The last time the scaling schedule became active. Note: this is a timestamp when a schedule actually became active, not when it was planned to do so. The timestamp is in RFC3339 text format.", "type": "string" }, "state": { "description": "[Output Only] The current state of a scaling schedule.", "type": "string", "enumDescriptions": [ "The current autoscaling recommendation is influenced by this scaling schedule.", "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 schedule." ], "enum": [ "ACTIVE", "DISABLED", "OBSOLETE", "READY" ] } } }, "AutoscalerAggregatedList": { "id": "AutoscalerAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.", "default": "compute#autoscalerAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of AutoscalersScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of autoscalers.", "$ref": "AutoscalersScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", "type": "array", "items": { "type": "string" } } } }, "AutoscalersScopedList": { "id": "AutoscalersScopedList", "type": "object", "properties": { "autoscalers": { "description": "[Output Only] A list of autoscalers contained in this scope.", "type": "array", "items": { "$ref": "Autoscaler" } }, "warning": { "description": "[Output Only] Informational warning which replaces the list of autoscalers when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "RegionAutoscalerList": { "id": "RegionAutoscalerList", "description": "Contains a list of autoscalers.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#regionAutoscalerList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Autoscaler resources.", "type": "array", "items": { "$ref": "Autoscaler" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "BackendBucketList": { "id": "BackendBucketList", "description": "Contains a list of BackendBucket resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#backendBucketList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of BackendBucket resources.", "type": "array", "items": { "$ref": "BackendBucket" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "BackendBucket": { "id": "BackendBucket", "description": "Represents a Cloud Storage Bucket resource. This Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.", "type": "object", "properties": { "kind": { "description": "Type of the resource.", "default": "compute#backendBucket", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional textual description of the resource; provided by the client when the resource is created.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "bucketName": { "description": "Cloud Storage bucket name.", "type": "string" }, "enableCdn": { "description": "If true, enable Cloud CDN for this BackendBucket.", "type": "boolean" }, "cdnPolicy": { "description": "Cloud CDN configuration for this BackendBucket.", "$ref": "BackendBucketCdnPolicy" }, "customResponseHeaders": { "description": "Headers that the Application Load Balancer should add to proxied responses.", "type": "array", "items": { "type": "string" } }, "edgeSecurityPolicy": { "description": "[Output Only] The resource URL for the edge security policy associated with this backend bucket.", "type": "string" }, "compressionMode": { "description": "Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.", "type": "string", "enumDescriptions": [ "Automatically uses the best compression based on the Accept-Encoding header sent by the client.", "Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients." ], "enum": [ "AUTOMATIC", "DISABLED" ] }, "usedBy": { "description": "[Output Only] List of resources referencing that backend bucket.", "type": "array", "items": { "$ref": "BackendBucketUsedBy" } } } }, "BackendBucketCdnPolicy": { "id": "BackendBucketCdnPolicy", "description": "Message containing Cloud CDN configuration for a backend bucket.", "type": "object", "properties": { "signedUrlKeyNames": { "description": "[Output Only] Names of the keys for signing request URLs.", "type": "array", "items": { "type": "string" } }, "signedUrlCacheMaxAgeSec": { "description": "Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a \"Cache-Control: public, max-age=[TTL]\" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.", "type": "string", "format": "int64" }, "requestCoalescing": { "description": "If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.", "type": "boolean" }, "cacheMode": { "description": "Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. If no value is provided for cdnPolicy.cacheMode, it defaults to CACHE_ALL_STATIC.", "type": "string", "enumDescriptions": [ "Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.", "Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.", "", "Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server." ], "enum": [ "CACHE_ALL_STATIC", "FORCE_CACHE_ALL", "INVALID_CACHE_MODE", "USE_ORIGIN_HEADERS" ] }, "defaultTtl": { "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", "type": "integer", "format": "int32" }, "maxTtl": { "description": "Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of \"0\" means \"always revalidate\". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", "type": "integer", "format": "int32" }, "clientTtl": { "description": "Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a \"public\" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a \"public\" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).", "type": "integer", "format": "int32" }, "negativeCaching": { "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", "type": "boolean" }, "negativeCachingPolicy": { "description": "Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.", "type": "array", "items": { "$ref": "BackendBucketCdnPolicyNegativeCachingPolicy" } }, "bypassCacheOnRequestHeaders": { "description": "Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.", "type": "array", "items": { "$ref": "BackendBucketCdnPolicyBypassCacheOnRequestHeader" } }, "serveWhileStale": { "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", "type": "integer", "format": "int32" }, "cacheKeyPolicy": { "description": "The CacheKeyPolicy for this CdnPolicy.", "$ref": "BackendBucketCdnPolicyCacheKeyPolicy" } } }, "BackendBucketCdnPolicyNegativeCachingPolicy": { "id": "BackendBucketCdnPolicyNegativeCachingPolicy", "description": "Specify CDN TTLs for response error codes.", "type": "object", "properties": { "code": { "description": "The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.", "type": "integer", "format": "int32" }, "ttl": { "description": "The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", "type": "integer", "format": "int32" } } }, "BackendBucketCdnPolicyBypassCacheOnRequestHeader": { "id": "BackendBucketCdnPolicyBypassCacheOnRequestHeader", "description": "Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.", "type": "object", "properties": { "headerName": { "description": "The header field name to match on when bypassing cache. Values are case-insensitive.", "type": "string" } } }, "BackendBucketCdnPolicyCacheKeyPolicy": { "id": "BackendBucketCdnPolicyCacheKeyPolicy", "description": "Message containing what to include in the cache key for a request for Cloud CDN.", "type": "object", "properties": { "queryStringWhitelist": { "description": "Names of query string parameters to include in cache keys. Default parameters are always included. '&' and '=' will be percent encoded and not treated as delimiters.", "type": "array", "items": { "type": "string" } }, "includeHttpHeaders": { "description": "Allows HTTP request headers (by name) to be used in the cache key.", "type": "array", "items": { "type": "string" } } } }, "BackendBucketUsedBy": { "id": "BackendBucketUsedBy", "type": "object", "properties": { "reference": { "description": "[Output Only] Server-defined URL for UrlMaps referencing that BackendBucket.", "type": "string" } } }, "SignedUrlKey": { "id": "SignedUrlKey", "description": "Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs", "type": "object", "properties": { "keyName": { "description": "Name of the key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "keyValue": { "description": "128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.", "type": "string" } } }, "SecurityPolicyReference": { "id": "SecurityPolicyReference", "type": "object", "properties": { "securityPolicy": { "type": "string" } } }, "BackendServiceList": { "id": "BackendServiceList", "description": "Contains a list of BackendService resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.", "default": "compute#backendServiceList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of BackendService resources.", "type": "array", "items": { "$ref": "BackendService" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "BackendService": { "id": "BackendService", "description": "Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https:\/\/cloud.google.com\/compute\/docs\/reference\/rest\/v2\/backendServices) * [Regional](https:\/\/cloud.google.com\/compute\/docs\/reference\/rest\/v2\/regionBackendServices) For more information, see Backend Services.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#backendService for backend services.", "default": "compute#backendService", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "backends": { "description": "The list of backends that serve this BackendService.", "type": "array", "items": { "$ref": "Backend" } }, "healthChecks": { "description": "The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.", "type": "array", "items": { "type": "string" } }, "timeoutSec": { "description": "The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.", "type": "integer", "format": "int32" }, "port": { "description": "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port.", "deprecated": true, "type": "integer", "format": "int32" }, "protocol": { "description": "The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.", "type": "string", "enumDescriptions": [ "gRPC (available for Traffic Director).", "", "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 any L3\/L4 Forwarding Rules." ], "enum": [ "GRPC", "HTTP", "HTTP2", "HTTPS", "SSL", "TCP", "UDP", "UNSPECIFIED" ] }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.", "type": "string", "format": "byte" }, "portName": { "description": "A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https:\/\/cloud.google.com\/load-balancing\/docs\/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port_name.", "type": "string" }, "enableCDN": { "description": "If true, enables Cloud CDN for the backend service of a global external Application Load Balancer.", "type": "boolean" }, "sessionAffinity": { "description": "Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https:\/\/cloud.google.com\/load-balancing\/docs\/backend-service#session_affinity).", "type": "string", "enumDescriptions": [ "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.", "1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP\/UDP Load Balancing.", "5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.", "3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.", "Hash based on a cookie generated by the L7 loadbalancer. Only 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 to any instance in the pool.", "Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired." ], "enum": [ "CLIENT_IP", "CLIENT_IP_NO_DESTINATION", "CLIENT_IP_PORT_PROTO", "CLIENT_IP_PROTO", "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE", "NONE", "STRONG_COOKIE_AFFINITY" ] }, "affinityCookieTtlSec": { "description": "Lifetime of cookies in seconds. This setting is applicable to Application Load Balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "type": "integer", "format": "int32" }, "region": { "description": "[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "failoverPolicy": { "description": "Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https:\/\/cloud.google.com\/load-balancing\/docs\/internal\/failover-overview) and [external passthrough Network Load Balancers](https:\/\/cloud.google.com\/load-balancing\/docs\/network\/networklb-failover-overview).", "$ref": "BackendServiceFailoverPolicy" }, "loadBalancingScheme": { "description": "Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.", "type": "string", "enumDescriptions": [ "Signifies that this will be used for classic Application Load Balancers, global external proxy Network Load Balancers, or external passthrough Network Load Balancers.", "Signifies that this will be used for global external Application Load Balancers, regional external Application Load Balancers, or regional external proxy Network Load Balancers.", "Signifies that this will be used for internal passthrough Network Load Balancers.", "Signifies that this will be used for internal Application Load Balancers.", "Signifies that this will be used by Traffic Director.", "" ], "enum": [ "EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED", "INTERNAL_SELF_MANAGED", "INVALID_LOAD_BALANCING_SCHEME" ] }, "connectionDraining": { "$ref": "ConnectionDraining" }, "iap": { "description": "The configurations for Identity-Aware Proxy on this resource. Not available for internal passthrough Network Load Balancers and external passthrough Network Load Balancers.", "$ref": "BackendServiceIAP" }, "cdnPolicy": { "description": "Cloud CDN configuration for this BackendService. Only available for specified load balancer types.", "$ref": "BackendServiceCdnPolicy" }, "customRequestHeaders": { "description": "Headers that the load balancer adds to proxied requests. See [Creating custom headers](https:\/\/cloud.google.com\/load-balancing\/docs\/custom-headers).", "type": "array", "items": { "type": "string" } }, "customResponseHeaders": { "description": "Headers that the load balancer adds to proxied responses. See [Creating custom headers](https:\/\/cloud.google.com\/load-balancing\/docs\/custom-headers).", "type": "array", "items": { "type": "string" } }, "securityPolicy": { "description": "[Output Only] The resource URL for the security policy associated with this backend service.", "type": "string" }, "edgeSecurityPolicy": { "description": "[Output Only] The resource URL for the edge security policy associated with this backend service.", "type": "string" }, "logConfig": { "description": "This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.", "$ref": "BackendServiceLogConfig" }, "securitySettings": { "description": "This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.", "$ref": "SecuritySettings" }, "localityLbPolicy": { "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring\/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition\/removal of a host from a set of N hosts only affects 1\/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https:\/\/ai.google\/research\/pubs\/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured\u2014that is, if session affinity remains at the default value of NONE\u2014then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "type": "string", "enumDescriptions": [ "", "An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.", "This algorithm implements consistent hashing to backends. Maglev can be used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https:\/\/ai.google\/research\/pubs\/pub44824", "Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.", "The load balancer selects a random healthy host.", "The ring\/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition\/removal of a host from a set of N hosts only affects 1\/N of the requests.", "This is a simple policy in which each healthy backend is selected in round robin order. This is the default.", "Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing." ], "enum": [ "INVALID_LB_POLICY", "LEAST_REQUEST", "MAGLEV", "ORIGINAL_DESTINATION", "RANDOM", "RING_HASH", "ROUND_ROBIN", "WEIGHTED_MAGLEV" ] }, "consistentHash": { "description": "Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added\/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. ", "$ref": "ConsistentHashLoadBalancerSettings" }, "circuitBreakers": { "$ref": "CircuitBreakers" }, "outlierDetection": { "description": "Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "$ref": "OutlierDetection" }, "network": { "description": "The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.", "type": "string" }, "subsetting": { "$ref": "Subsetting" }, "connectionTrackingPolicy": { "description": "Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers.", "$ref": "BackendServiceConnectionTrackingPolicy" }, "maxStreamDuration": { "description": "Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.", "$ref": "Duration" }, "compressionMode": { "description": "Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.", "type": "string", "enumDescriptions": [ "Automatically uses the best compression based on the Accept-Encoding header sent by the client.", "Disables compression. Existing compressed responses cached by Cloud CDN will not be served to clients." ], "enum": [ "AUTOMATIC", "DISABLED" ] }, "serviceLbPolicy": { "description": "URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.", "type": "string" }, "serviceBindings": { "description": "URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.", "type": "array", "items": { "type": "string" } }, "localityLbPolicies": { "description": "A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.", "type": "array", "items": { "$ref": "BackendServiceLocalityLoadBalancingPolicyConfig" } }, "ipAddressSelectionPolicy": { "description": "Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). ", "type": "string", "enumDescriptions": [ "Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting.", "Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends.", "Unspecified IP address selection policy.", "Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address)." ], "enum": [ "IPV4_ONLY", "IPV6_ONLY", "IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED", "PREFER_IPV6" ] }, "metadatas": { "description": "Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH", "type": "object", "additionalProperties": { "type": "string" } }, "usedBy": { "description": "[Output Only] List of resources referencing given backend service.", "type": "array", "items": { "$ref": "BackendServiceUsedBy" } }, "strongSessionAffinityCookie": { "description": "Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY.", "$ref": "BackendServiceHttpCookie" } } }, "Backend": { "id": "Backend", "description": "Message containing information of one individual backend.", "type": "object", "properties": { "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "group": { "description": "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https:\/\/cloud.google.com\/load-balancing\/docs\/backend-service#backends). You must use the fully-qualified* URL (starting with https:\/\/www.googleapis.com\/) to specify the instance group or NEG. Partial URLs are not supported.", "type": "string" }, "balancingMode": { "description": "Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.", "type": "string", "enumDescriptions": [ "Balance based on the number of simultaneous connections.", "Balance based on requests per second (RPS).", "Balance based on the backend utilization." ], "enum": [ "CONNECTION", "RATE", "UTILIZATION" ] }, "maxUtilization": { "description": "Optional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode.", "type": "number", "format": "float" }, "maxRate": { "description": "Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.", "type": "integer", "format": "int32" }, "maxRatePerInstance": { "description": "Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.", "type": "number", "format": "float" }, "maxRatePerEndpoint": { "description": "Defines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION.", "type": "number", "format": "float" }, "maxConnections": { "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.", "type": "integer", "format": "int32" }, "maxConnectionsPerInstance": { "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.", "type": "integer", "format": "int32" }, "maxConnectionsPerEndpoint": { "description": "Defines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE.", "type": "integer", "format": "int32" }, "capacityScaler": { "description": "A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs.", "type": "number", "format": "float" }, "failover": { "description": "This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.", "type": "boolean" }, "preference": { "description": "This field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default ", "type": "string", "enumDescriptions": [ "No preference.", "If preference is unspecified, we set it to the DEFAULT value", "Traffic will be sent to this backend first." ], "enum": [ "DEFAULT", "PREFERENCE_UNSPECIFIED", "PREFERRED" ] } } }, "BackendServiceFailoverPolicy": { "id": "BackendServiceFailoverPolicy", "description": "For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https:\/\/cloud.google.com\/load-balancing\/docs\/internal\/failover-overview) and [external passthrough Network Load Balancers](https:\/\/cloud.google.com\/load-balancing\/docs\/network\/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).", "type": "object", "properties": { "disableConnectionDrainOnFailover": { "description": "This can be set to true only if the protocol is TCP. The default is false.", "type": "boolean" }, "dropTrafficIfUnhealthy": { "description": "If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https:\/\/cloud.google.com\/load-balancing\/docs\/internal\/failover-overview) and [external passthrough Network Load Balancers](https:\/\/cloud.google.com\/load-balancing\/docs\/network\/networklb-failover-overview). The 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 failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. For load balancers that have configurable failover: [Internal TCP\/UDP Load Balancing](https:\/\/cloud.google.com\/load-balancing\/docs\/internal\/failover-overview) and [external TCP\/UDP Load Balancing](https:\/\/cloud.google.com\/load-balancing\/docs\/network\/networklb-failover-overview).", "type": "number", "format": "float" } } }, "ConnectionDraining": { "id": "ConnectionDraining", "description": "Message containing connection draining configuration.", "type": "object", "properties": { "drainingTimeoutSec": { "description": "Configures a duration timeout for existing requests on a removed backend instance. For supported load balancers and protocols, as described in Enabling connection draining.", "type": "integer", "format": "int32" } } }, "BackendServiceIAP": { "id": "BackendServiceIAP", "description": "Identity-Aware Proxy", "type": "object", "properties": { "enabled": { "description": "Whether the serving infrastructure will authenticate and authorize all incoming 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. For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field. @InputOnly", "type": "string" }, "oauth2ClientSecretSha256": { "description": "[Output Only] SHA256 hash value for the field oauth2_client_secret above.", "type": "string" } } }, "BackendServiceCdnPolicy": { "id": "BackendServiceCdnPolicy", "description": "Message containing Cloud CDN configuration for a backend service.", "type": "object", "properties": { "cacheKeyPolicy": { "description": "The CacheKeyPolicy for this CdnPolicy.", "$ref": "CacheKeyPolicy" }, "signedUrlKeyNames": { "description": "[Output Only] Names of the keys for signing request URLs.", "type": "array", "items": { "type": "string" } }, "signedUrlCacheMaxAgeSec": { "description": "Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a \"Cache-Control: public, max-age=[TTL]\" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.", "type": "string", "format": "int64" }, "requestCoalescing": { "description": "If true then Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin.", "type": "boolean" }, "cacheMode": { "description": "Specifies the cache setting for all responses from this backend. The possible values are: USE_ORIGIN_HEADERS Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server. FORCE_CACHE_ALL Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content. CACHE_ALL_STATIC Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached. If no value is provided for cdnPolicy.cacheMode, it defaults to CACHE_ALL_STATIC.", "type": "string", "enumDescriptions": [ "Automatically cache static content, including common image formats, media (video and audio), and web assets (JavaScript and CSS). Requests and responses that are marked as uncacheable, as well as dynamic content (including HTML), will not be cached.", "Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\" directives in Cache-Control response headers. Warning: this may result in Cloud CDN caching private, per-user (user identifiable) content.", "", "Requires the origin to set valid caching headers to cache content. Responses without these headers will not be cached at Google's edge, and will require a full trip to the origin on every request, potentially impacting performance and increasing load on the origin server." ], "enum": [ "CACHE_ALL_STATIC", "FORCE_CACHE_ALL", "INVALID_CACHE_MODE", "USE_ORIGIN_HEADERS" ] }, "defaultTtl": { "description": "Specifies the default TTL for cached content served by this origin for responses that do not have an existing valid TTL (max-age or s-max-age). Setting a TTL of \"0\" means \"always revalidate\". The value of defaultTTL cannot be set to a value greater than that of maxTTL, but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL will overwrite the TTL set in all responses. The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", "type": "integer", "format": "int32" }, "maxTtl": { "description": "Specifies the maximum allowed TTL for cached content served by this origin. Cache directives that attempt to set a max-age or s-maxage higher than this, or an Expires header more than maxTTL seconds in the future will be capped at the value of maxTTL, as if it were the value of an s-maxage Cache-Control directive. Headers sent to the client will not be modified. Setting a TTL of \"0\" means \"always revalidate\". The maximum allowed value is 31,622,400s (1 year), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", "type": "integer", "format": "int32" }, "clientTtl": { "description": "Specifies a separate client (e.g. browser client) maximum TTL. This is used to clamp the max-age (or Expires) value sent to the client. With FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the response max-age directive, along with a \"public\" directive. For cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age from the origin (if specified), or else sets the response max-age directive to the lesser of the client_ttl and default_ttl, and also ensures a \"public\" cache-control directive is present. If a client TTL is not specified, a default value (1 hour) will be used. The maximum allowed value is 31,622,400s (1 year).", "type": "integer", "format": "int32" }, "negativeCaching": { "description": "Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects. This can reduce the load on your origin and improve end-user experience by reducing response latency. When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to responses with the specified response code that lack any Cache-Control, Expires, or Pragma: no-cache directives. When the cache mode is set to FORCE_CACHE_ALL, negative caching applies to all responses with the specified response code, and override any caching headers. By default, Cloud CDN will apply the following default TTLs to these status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected Request), 501 (Not Implemented): 60s. These defaults can be overridden in negative_caching_policy.", "type": "boolean" }, "negativeCachingPolicy": { "description": "Sets a cache TTL for the specified HTTP status code. negative_caching must be enabled to configure negative_caching_policy. Omitting the policy and leaving negative_caching enabled will use Cloud CDN's default cache TTLs. Note that when specifying an explicit negative_caching_policy, you should take care to specify a cache TTL for all response codes that you wish to cache. Cloud CDN will not apply any default negative caching when a policy exists.", "type": "array", "items": { "$ref": "BackendServiceCdnPolicyNegativeCachingPolicy" } }, "bypassCacheOnRequestHeaders": { "description": "Bypass the cache when the specified request headers are matched - e.g. Pragma or Authorization headers. Up to 5 headers can be specified. The cache is bypassed for all cdnPolicy.cacheMode settings.", "type": "array", "items": { "$ref": "BackendServiceCdnPolicyBypassCacheOnRequestHeader" } }, "serveWhileStale": { "description": "Serve existing content from the cache (if available) when revalidating content with the origin, or when an error is encountered when refreshing the cache. This setting defines the default \"max-stale\" duration for any cached responses that do not specify a max-stale directive. Stale responses that exceed the TTL configured here will not be served. The default limit (max-stale) is 86400s (1 day), which will allow stale content to be served up to this limit beyond the max-age (or s-max-age) of a cached response. The maximum allowed value is 604800 (1 week). Set this to zero (0) to disable serve-while-stale.", "type": "integer", "format": "int32" } } }, "CacheKeyPolicy": { "id": "CacheKeyPolicy", "description": "Message containing what to include in the cache key for a request for Cloud CDN.", "type": "object", "properties": { "includeProtocol": { "description": "If true, http and https requests will be cached separately.", "type": "boolean" }, "includeHost": { "description": "If true, requests to different hosts will be cached separately.", "type": "boolean" }, "includeQueryString": { "description": "If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.", "type": "boolean" }, "queryStringWhitelist": { "description": "Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.", "type": "array", "items": { "type": "string" } }, "queryStringBlacklist": { "description": "Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '&' and '=' will be percent encoded and not treated as delimiters.", "type": "array", "items": { "type": "string" } }, "includeHttpHeaders": { "description": "Allows HTTP request headers (by name) to be used in the cache key.", "type": "array", "items": { "type": "string" } }, "includeNamedCookies": { "description": "Allows HTTP cookies (by name) to be used in the cache key. The name=value pair will be used in the cache key Cloud CDN generates.", "type": "array", "items": { "type": "string" } } } }, "BackendServiceCdnPolicyNegativeCachingPolicy": { "id": "BackendServiceCdnPolicyNegativeCachingPolicy", "description": "Specify CDN TTLs for response error codes.", "type": "object", "properties": { "code": { "description": "The HTTP status code to define a TTL against. Only HTTP status codes 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified as values, and you cannot specify a status code more than once.", "type": "integer", "format": "int32" }, "ttl": { "description": "The TTL (in seconds) for which to cache responses with the corresponding status code. The maximum allowed value is 1800s (30 minutes), noting that infrequently accessed objects may be evicted from the cache before the defined TTL.", "type": "integer", "format": "int32" } } }, "BackendServiceCdnPolicyBypassCacheOnRequestHeader": { "id": "BackendServiceCdnPolicyBypassCacheOnRequestHeader", "description": "Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.", "type": "object", "properties": { "headerName": { "description": "The header field name to match on when bypassing cache. Values are case-insensitive.", "type": "string" } } }, "BackendServiceLogConfig": { "id": "BackendServiceLogConfig", "description": "The available logging options for the load balancer traffic served by this backend service.", "type": "object", "properties": { "enable": { "description": "Denotes whether to enable logging for the load balancer traffic served by this backend service. The default value is false.", "type": "boolean" }, "sampleRate": { "description": "This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.", "type": "number", "format": "float" }, "optionalMode": { "description": "This field can only be specified if logging is enabled for this backend service. Configures whether all, none or a subset of optional fields should be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.", "type": "string", "enumDescriptions": [ "A subset of optional fields.", "None optional fields.", "All optional fields." ], "enum": [ "CUSTOM", "EXCLUDE_ALL_OPTIONAL", "INCLUDE_ALL_OPTIONAL" ] }, "optionalFields": { "description": "This field can only be specified if logging is enabled for this backend service and \"logConfig.optionalMode\" was set to CUSTOM. Contains a list of optional fields you want to include in the logs. For example: serverInstance, serverGkeDetails.cluster, serverGkeDetails.pod.podNamespace", "type": "array", "items": { "type": "string" } } } }, "SecuritySettings": { "id": "SecuritySettings", "description": "The authentication and authorization settings for a BackendService.", "type": "object", "properties": { "clientTlsPolicy": { "description": "Optional. A URL referring to a networksecurity.ClientTlsPolicy resource that describes how clients should authenticate with this service's backends. clientTlsPolicy only applies to a global BackendService with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. If left blank, communications are not encrypted.", "type": "string" }, "subjectAltNames": { "description": "Optional. A list of Subject Alternative Names (SANs) that the client verifies during a mutual TLS handshake with an server\/endpoint for this BackendService. When the server presents its X.509 certificate to the client, the client inspects the certificate's subjectAltName field. If the field contains one of the specified values, the communication continues. Otherwise, it fails. This additional check enables the client to verify that the server is authorized to run the requested service. Note that the contents of the server certificate's subjectAltName field are configured by the Public Key Infrastructure which provisions server identities. Only applies to a global BackendService with loadBalancingScheme set to INTERNAL_SELF_MANAGED. Only applies when BackendService has an attached clientTlsPolicy with clientCertificate (mTLS mode).", "type": "array", "items": { "type": "string" } }, "awsV4Authentication": { "description": "The configuration needed to generate a signature for access to private storage buckets that support AWS's Signature Version 4 for authentication. Allowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends.", "$ref": "AWSV4Signature" } } }, "AWSV4Signature": { "id": "AWSV4Signature", "description": "Contains the configurations necessary to generate a signature for access to private storage buckets that support Signature Version 4 for authentication. The service name for generating the authentication header will always default to 's3'.", "type": "object", "properties": { "accessKeyId": { "description": "The identifier of an access key used for s3 bucket authentication.", "type": "string" }, "accessKey": { "description": "The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly", "type": "string" }, "accessKeyVersion": { "description": "The optional version identifier for the access key. You can use this to keep 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 the name of the region your cloud uses to host your origin. For example, \"us-east-1\" for AWS or \"us-ashburn-1\" for OCI.", "type": "string" } } }, "ConsistentHashLoadBalancerSettings": { "id": "ConsistentHashLoadBalancerSettings", "description": "This message defines settings for a consistent hash style load balancer.", "type": "object", "properties": { "httpCookie": { "description": "Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "$ref": "ConsistentHashLoadBalancerSettingsHttpCookie" }, "httpHeaderName": { "description": "The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.", "type": "string" }, "minimumRingSize": { "description": "The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.", "type": "string", "format": "int64" } } }, "ConsistentHashLoadBalancerSettingsHttpCookie": { "id": "ConsistentHashLoadBalancerSettingsHttpCookie", "description": "The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash.", "type": "object", "properties": { "name": { "description": "Name of the cookie.", "type": "string" }, "path": { "description": "Path to set for the cookie.", "type": "string" }, "ttl": { "description": "Lifetime of the cookie.", "$ref": "Duration" } } }, "CircuitBreakers": { "id": "CircuitBreakers", "description": "Settings controlling the volume of requests, connections and retries to this backend service.", "type": "object", "properties": { "maxRequestsPerConnection": { "description": "Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP\/1.1 and HTTP\/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "type": "integer", "format": "int32" }, "maxConnections": { "description": "The maximum number of connections to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "type": "integer", "format": "int32" }, "maxPendingRequests": { "description": "The maximum number of pending requests allowed to the backend service. If not specified, there is no limit. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "type": "integer", "format": "int32" }, "maxRequests": { "description": "The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.", "type": "integer", "format": "int32" }, "maxRetries": { "description": "The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "type": "integer", "format": "int32" } } }, "OutlierDetection": { "id": "OutlierDetection", "description": "Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.", "type": "object", "properties": { "consecutiveErrors": { "description": "Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.", "type": "integer", "format": "int32" }, "interval": { "description": "Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.", "$ref": "Duration" }, "baseEjectionTime": { "description": "The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s. After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.", "$ref": "Duration" }, "maxEjectionPercent": { "description": "Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.", "type": "integer", "format": "int32" }, "enforcingConsecutiveErrors": { "description": "The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.", "type": "integer", "format": "int32" }, "enforcingSuccessRate": { "description": "The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100. Not supported when the backend service uses Serverless NEG.", "type": "integer", "format": "int32" }, "successRateMinimumHosts": { "description": "The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5. Not supported when the backend service uses Serverless NEG.", "type": "integer", "format": "int32" }, "successRateRequestVolume": { "description": "The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100. Not supported when the backend service uses Serverless NEG.", "type": "integer", "format": "int32" }, "successRateStdevFactor": { "description": "This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900. Not supported when the backend service uses Serverless NEG.", "type": "integer", "format": "int32" }, "consecutiveGatewayFailure": { "description": "The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.", "type": "integer", "format": "int32" }, "enforcingConsecutiveGatewayFailure": { "description": "The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.", "type": "integer", "format": "int32" } } }, "Subsetting": { "id": "Subsetting", "description": "Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP\/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.", "type": "object", "properties": { "policy": { "type": "string", "enumDescriptions": [ "Subsetting based on consistent hashing. For Traffic Director, the number of backends per backend group (the subset size) is based on the `subset_size` parameter. For Internal HTTP(S) load balancing, the number of backends per backend group (the subset size) is dynamically adjusted in two cases: - As the number of proxy instances participating in Internal HTTP(S) load balancing increases, the subset size decreases. - When the total number of backends in a network exceeds the capacity of a single proxy instance, subset sizes are reduced automatically for each service that has backend subsetting enabled.", "No Subsetting. Clients may open connections and send traffic to all backends of this backend service. This can lead to performance issues if there is substantial imbalance in the count of clients and backends." ], "enum": [ "CONSISTENT_HASH_SUBSETTING", "NONE" ] } } }, "BackendServiceConnectionTrackingPolicy": { "id": "BackendServiceConnectionTrackingPolicy", "description": "Connection Tracking configuration for this BackendService.", "type": "object", "properties": { "trackingMode": { "description": "Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see [Tracking Mode for Network Load Balancing](https:\/\/cloud.google.com\/load-balancing\/docs\/network\/networklb-backend-service#tracking-mode) and [Tracking Mode for Internal TCP\/UDP Load Balancing](https:\/\/cloud.google.com\/load-balancing\/docs\/internal#tracking-mode).", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "INVALID_TRACKING_MODE", "PER_CONNECTION", "PER_SESSION" ] }, "connectionPersistenceOnUnhealthyBackends": { "description": "Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see [Connection Persistence for Network Load Balancing](https:\/\/cloud.google.com\/load-balancing\/docs\/network\/networklb-backend-service#connection-persistence) and [Connection Persistence for Internal TCP\/UDP Load Balancing](https:\/\/cloud.google.com\/load-balancing\/docs\/internal#connection-persistence).", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "ALWAYS_PERSIST", "DEFAULT_FOR_PROTOCOL", "NEVER_PERSIST" ] }, "idleTimeoutSec": { "description": "Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For internal passthrough Network Load Balancers: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For external passthrough Network Load Balancers the default is 60 seconds. This option is not available publicly.", "type": "integer", "format": "int32" }, "enableStrongAffinity": { "description": "Enable Strong Session Affinity for external passthrough Network Load Balancers. This option is not available publicly.", "type": "boolean" } } }, "BackendServiceLocalityLoadBalancingPolicyConfig": { "id": "BackendServiceLocalityLoadBalancingPolicyConfig", "description": "Container for either a built-in LB policy supported by gRPC or Envoy or a custom one implemented by the end user.", "type": "object", "properties": { "policy": { "$ref": "BackendServiceLocalityLoadBalancingPolicyConfigPolicy" }, "customPolicy": { "$ref": "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy" } } }, "BackendServiceLocalityLoadBalancingPolicyConfigPolicy": { "id": "BackendServiceLocalityLoadBalancingPolicyConfigPolicy", "description": "The configuration for a built-in load balancing policy.", "type": "object", "properties": { "name": { "description": "The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.", "type": "string", "enumDescriptions": [ "", "An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.", "This algorithm implements consistent hashing to backends. Maglev can be used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https:\/\/ai.google\/research\/pubs\/pub44824", "Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.", "The load balancer selects a random healthy host.", "The ring\/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition\/removal of a host from a set of N hosts only affects 1\/N of the requests.", "This is a simple policy in which each healthy backend is selected in round robin order. This is the default.", "Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing." ], "enum": [ "INVALID_LB_POLICY", "LEAST_REQUEST", "MAGLEV", "ORIGINAL_DESTINATION", "RANDOM", "RING_HASH", "ROUND_ROBIN", "WEIGHTED_MAGLEV" ] } } }, "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy": { "id": "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy", "description": "The configuration for a custom policy implemented by the user and deployed with the client.", "type": "object", "properties": { "name": { "description": "Identifies the custom policy. The value should match the name of a custom implementation registered on the gRPC clients. It should follow protocol buffer message naming conventions and include the full path (for example, myorg.CustomLbPolicy). The maximum length is 256 characters. Do not specify the same custom policy more than once for a backend. If you do, the configuration is rejected. For an example of how to use this field, see Use a custom policy.", "type": "string" }, "data": { "description": "An optional, arbitrary JSON object with configuration data, understood by a locally installed custom policy implementation.", "type": "string" } } }, "BackendServiceUsedBy": { "id": "BackendServiceUsedBy", "type": "object", "properties": { "reference": { "description": "[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.", "type": "string" } } }, "BackendServiceHttpCookie": { "id": "BackendServiceHttpCookie", "description": "The HTTP cookie used for stateful session affinity.", "type": "object", "properties": { "name": { "description": "Name of the cookie.", "type": "string" }, "path": { "description": "Path to set for the cookie.", "type": "string" }, "ttl": { "description": "Lifetime of the cookie.", "$ref": "Duration" } } }, "BackendServiceAggregatedList": { "id": "BackendServiceAggregatedList", "description": "Contains a list of BackendServicesScopedList.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#backendServiceAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of BackendServicesScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of BackendServices.", "$ref": "BackendServicesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "BackendServicesScopedList": { "id": "BackendServicesScopedList", "type": "object", "properties": { "backendServices": { "description": "A list of BackendServices contained in this scope.", "type": "array", "items": { "$ref": "BackendService" } }, "warning": { "description": "Informational warning which replaces the list of backend services when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "BackendServiceListUsable": { "id": "BackendServiceListUsable", "description": "Contains a list of usable BackendService resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#usableBackendServiceList for lists of usable backend services.", "default": "compute#usableBackendServiceList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of BackendService resources.", "type": "array", "items": { "$ref": "BackendService" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "ResourceGroupReference": { "id": "ResourceGroupReference", "type": "object", "properties": { "group": { "description": "A URI referencing one of the instance groups or network endpoint groups listed in the backend service.", "type": "string" } } }, "BackendServiceGroupHealth": { "id": "BackendServiceGroupHealth", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.", "default": "compute#backendServiceGroupHealth", "type": "string" }, "healthStatus": { "description": "Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks.", "type": "array", "items": { "$ref": "HealthStatus" } }, "annotations": { "description": "Metadata defined as annotations on the network endpoint group.", "type": "object", "additionalProperties": { "type": "string" } } } }, "HealthStatus": { "id": "HealthStatus", "type": "object", "properties": { "weight": { "type": "string" }, "weightError": { "type": "string", "enumDescriptions": [ "The response to a Health Check probe had the HTTP response header field X-Load-Balancing-Endpoint-Weight, but its content was invalid (i.e., not a non-negative single-precision floating-point number in decimal string representation).", "The response to a Health Check probe did not have the HTTP response header field X-Load-Balancing-Endpoint-Weight.", "This is the value when the accompanied health status is either TIMEOUT (i.e.,the Health Check probe was not able to get a response in time) or UNKNOWN. For the latter, it should be typically because there has not been sufficient time to parse and report the weight for a new backend (which is with 0.0.0.0 ip address). However, it can be also due to an outage case for which the health status is explicitly reset to UNKNOWN.", "This is the default value when WeightReportMode is DISABLE, and is also the initial value when WeightReportMode has just updated to ENABLE or DRY_RUN and there has not been sufficient time to parse and report the backend weight." ], "enum": [ "INVALID_WEIGHT", "MISSING_WEIGHT", "UNAVAILABLE_WEIGHT", "WEIGHT_NONE" ] }, "ipAddress": { "description": "For target pool based Network Load Balancing, it indicates the forwarding rule's IP address assigned to this instance. For other types of load balancing, the field indicates VM internal ip.", "type": "string" }, "ipv6Address": { "type": "string" }, "port": { "description": "The named port of the instance group, not necessarily the port that is health-checked.", "type": "integer", "format": "int32" }, "instance": { "description": "URL of the instance resource.", "type": "string" }, "healthState": { "description": "Health state of the IPv4 address of the instance.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "HEALTHY", "UNHEALTHY" ] }, "ipv6HealthState": { "description": "Health state of the IPv6 address of the instance.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "HEALTHY", "UNHEALTHY" ] }, "annotations": { "description": "Metadata defined as annotations for network endpoint.", "type": "object", "additionalProperties": { "type": "string" } }, "forwardingRuleIp": { "description": "A forwarding rule IP address assigned to this instance.", "type": "string" }, "forwardingRule": { "description": "URL of the forwarding rule associated with the health status of the instance.", "type": "string" } } }, "CommitmentList": { "id": "CommitmentList", "description": "Contains a list of Commitment resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#commitmentList for lists of commitments.", "default": "compute#commitmentList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Commitment resources.", "type": "array", "items": { "$ref": "Commitment" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Commitment": { "id": "Commitment", "description": "Represents a regional resource-based commitment resource. Creating this commitment resource means that you are purchasing a resource-based committed use contract, with an explicit start and end time. You can purchase resource-based commitments for both hardware and software resources. For more information, read Resource-based committed use discounts", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#commitment for commitments.", "default": "compute#commitment", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of the commitment. You can provide this property when you create the resource.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the commitment and committed resources are located.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "status": { "description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED.", "type": "string", "enumDescriptions": [ "", "Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.", "", "", "" ], "enum": [ "ACTIVE", "CANCELLED", "CREATING", "EXPIRED", "NOT_YET_ACTIVE" ] }, "statusMessage": { "description": "[Output Only] An optional, human-readable explanation of the status.", "type": "string" }, "plan": { "description": "The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "INVALID", "THIRTY_SIX_MONTH", "TWELVE_MONTH" ] }, "startTimestamp": { "description": "[Output Only] Commitment start time in RFC3339 text format.", "type": "string" }, "endTimestamp": { "description": "[Output Only] Commitment end time in RFC3339 text format.", "type": "string" }, "category": { "description": "The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "CATEGORY_UNSPECIFIED", "LICENSE", "MACHINE" ] }, "resources": { "description": "The list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.", "type": "array", "items": { "$ref": "ResourceCommitment" } }, "type": { "description": "The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following: ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3, ACCELERATOR_OPTIMIZED_A3_MEGA, COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, 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, MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3, MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series.", "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "Note for internal users: When adding a new enum Type for v1, make sure to also add it in the comment for the `optional Type type` definition. This ensures that the public documentation displays the new enum Type." ], "enum": [ "ACCELERATOR_OPTIMIZED", "ACCELERATOR_OPTIMIZED_A3", "ACCELERATOR_OPTIMIZED_A3_MEGA", "ACCELERATOR_OPTIMIZED_A3_ULTRA", "COMPUTE_OPTIMIZED", "COMPUTE_OPTIMIZED_C2D", "COMPUTE_OPTIMIZED_C3", "COMPUTE_OPTIMIZED_C3D", "COMPUTE_OPTIMIZED_H3", "GENERAL_PURPOSE", "GENERAL_PURPOSE_C4", "GENERAL_PURPOSE_C4A", "GENERAL_PURPOSE_E2", "GENERAL_PURPOSE_N2", "GENERAL_PURPOSE_N2D", "GENERAL_PURPOSE_N4", "GENERAL_PURPOSE_T2D", "GRAPHICS_OPTIMIZED", "MEMORY_OPTIMIZED", "MEMORY_OPTIMIZED_M3", "MEMORY_OPTIMIZED_X4_16TB", "MEMORY_OPTIMIZED_X4_24TB", "MEMORY_OPTIMIZED_X4_32TB", "STORAGE_OPTIMIZED_Z3", "TYPE_UNSPECIFIED" ] }, "reservations": { "description": "The list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify the existingReservations property instead.", "type": "array", "items": { "$ref": "Reservation" } }, "licenseResource": { "description": "The license specification required as part of a license commitment.", "$ref": "LicenseResourceCommitment" }, "autoRenew": { "description": "Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.", "type": "boolean" }, "mergeSourceCommitments": { "description": "The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.", "type": "array", "items": { "type": "string" } }, "splitSourceCommitment": { "description": "The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.", "type": "string" }, "resourceStatus": { "description": "[Output Only] Status information for Commitment resource.", "$ref": "CommitmentResourceStatus" }, "existingReservations": { "type": "array", "items": { "type": "string" } }, "customEndTimestamp": { "description": "[Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.", "type": "string" } } }, "ResourceCommitment": { "id": "ResourceCommitment", "description": "Commitment for a particular hardware resource (a commitment is composed of one or more of these).", "type": "object", "properties": { "type": { "description": "The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type.", "type": "string", "enumDescriptions": [ "", "", "", "", "" ], "enum": [ "ACCELERATOR", "LOCAL_SSD", "MEMORY", "UNSPECIFIED", "VCPU" ] }, "amount": { "description": "The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB. ", "type": "string", "format": "int64" }, "acceleratorType": { "description": "Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR.", "type": "string" } } }, "LicenseResourceCommitment": { "id": "LicenseResourceCommitment", "description": "Commitment for a particular license resource.", "type": "object", "properties": { "license": { "description": "The applicable license URI.", "type": "string" }, "amount": { "description": "The number of licenses you plan to purchase.", "type": "string", "format": "int64" }, "coresPerLicense": { "description": "The number of cores per license.", "type": "string" } } }, "CommitmentResourceStatus": { "id": "CommitmentResourceStatus", "description": "[Output Only] Contains output only fields.", "type": "object", "properties": { "customTermEligibilityEndTimestamp": { "description": "[Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.", "type": "string" } } }, "CommitmentAggregatedList": { "id": "CommitmentAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments.", "default": "compute#commitmentAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of CommitmentsScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of commitments.", "$ref": "CommitmentsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "CommitmentsScopedList": { "id": "CommitmentsScopedList", "type": "object", "properties": { "commitments": { "description": "[Output Only] The list of commitments contained in this scope.", "type": "array", "items": { "$ref": "Commitment" } }, "warning": { "description": "[Output Only] Informational warning which replaces the list of commitments when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "DiskTypeList": { "id": "DiskTypeList", "description": "Contains a list of disk types.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#diskTypeList for disk types.", "default": "compute#diskTypeList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of DiskType resources.", "type": "array", "items": { "$ref": "DiskType" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "DiskType": { "id": "DiskType", "description": "Represents a Disk Type resource. Google Compute Engine has two Disk Type resources: [Regional](\/compute\/docs\/reference\/rest\/v2\/regionDiskTypes) * [Zonal](\/compute\/docs\/reference\/rest\/v2\/diskTypes) You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#diskType for disk types.", "default": "compute#diskType", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "[Output Only] Name of the resource.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "[Output Only] An optional description of this resource.", "type": "string" }, "validDiskSize": { "description": "[Output Only] An optional textual description of the valid disk size, such as \"10GB-10TB\".", "type": "string" }, "deprecated": { "description": "[Output Only] The deprecation status associated with this disk type.", "$ref": "DeprecationStatus" }, "zone": { "description": "[Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "defaultDiskSizeGb": { "description": "[Output Only] Server-defined default disk size in GB.", "type": "string", "format": "int64" }, "region": { "description": "[Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" } } }, "DiskTypeAggregatedList": { "id": "DiskTypeAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#diskTypeAggregatedList.", "default": "compute#diskTypeAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of DiskTypesScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of disk types.", "$ref": "DiskTypesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "DiskTypesScopedList": { "id": "DiskTypesScopedList", "type": "object", "properties": { "diskTypes": { "description": "[Output Only] A list of disk types contained in this scope.", "type": "array", "items": { "$ref": "DiskType" } }, "warning": { "description": "[Output Only] Informational warning which replaces the list of disk types when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "RegionDiskTypeList": { "id": "RegionDiskTypeList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types.", "default": "compute#regionDiskTypeList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of DiskType resources.", "type": "array", "items": { "$ref": "DiskType" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InterconnectAttachmentList": { "id": "InterconnectAttachmentList", "description": "Response to the list request, and contains a list of interconnect attachments.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments.", "default": "compute#interconnectAttachmentList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InterconnectAttachment resources.", "type": "array", "items": { "$ref": "InterconnectAttachment" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InterconnectAttachment": { "id": "InterconnectAttachment", "description": "Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.", "default": "compute#interconnectAttachment", "type": "string" }, "description": { "description": "An optional description of this resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "interconnect": { "description": "URL of the underlying Interconnect object that this attachment's traffic will traverse through.", "type": "string" }, "router": { "description": "URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "googleReferenceId": { "description": "[Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.", "deprecated": true, "type": "string" }, "mtu": { "description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.", "type": "integer", "format": "int32" }, "privateInterconnectInfo": { "description": "[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.", "$ref": "InterconnectAttachmentPrivateInfo" }, "operationalStatus": { "description": "[Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. ", "type": "string", "enumDescriptions": [ "Indicates that attachment has been turned up and is ready to use.", "Indicates that attachment is not ready to use yet, because turnup is not complete." ], "enum": [ "OS_ACTIVE", "OS_UNPROVISIONED" ] }, "cloudRouterIpAddress": { "description": "[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.", "type": "string" }, "customerRouterIpAddress": { "description": "[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.", "type": "string" }, "type": { "description": "The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. ", "type": "string", "enumDescriptions": [ "Attachment to a dedicated interconnect.", "Attachment to a partner interconnect, created by the customer.", "Attachment to a partner interconnect, created by the partner." ], "enum": [ "DEDICATED", "PARTNER", "PARTNER_PROVIDER" ] }, "pairingKey": { "description": "[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form \"XXXXX\/region\/domain\"", "type": "string" }, "adminEnabled": { "description": "Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.", "type": "boolean" }, "vlanTag8021q": { "description": "The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.", "type": "integer", "format": "int32" }, "edgeAvailabilityDomain": { "description": "Input only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "AVAILABILITY_DOMAIN_1", "AVAILABILITY_DOMAIN_2", "AVAILABILITY_DOMAIN_ANY" ] }, "candidateSubnets": { "description": "Input only. Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0\/16) and must be \/29 or shorter (\/28, \/27, etc). Google will attempt to select an unused \/29 from the supplied candidate prefix(es). The request will fail if all possible \/29s are in use on Google's edge. If not supplied, Google will randomly select an unused \/29 from all of link-local space.", "type": "array", "items": { "type": "string" } }, "bandwidth": { "description": "Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit\/s - BPS_100M: 100 Mbit\/s - BPS_200M: 200 Mbit\/s - BPS_300M: 300 Mbit\/s - BPS_400M: 400 Mbit\/s - BPS_500M: 500 Mbit\/s - BPS_1G: 1 Gbit\/s - BPS_2G: 2 Gbit\/s - BPS_5G: 5 Gbit\/s - BPS_10G: 10 Gbit\/s - BPS_20G: 20 Gbit\/s - BPS_50G: 50 Gbit\/s - BPS_100G: 100 Gbit\/s ", "type": "string", "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 Mbit\/s", "500 Mbit\/s", "50 Gbit\/s", "50 Mbit\/s", "5 Gbit\/s" ], "enum": [ "BPS_100G", "BPS_100M", "BPS_10G", "BPS_1G", "BPS_200M", "BPS_20G", "BPS_2G", "BPS_300M", "BPS_400M", "BPS_500M", "BPS_50G", "BPS_50M", "BPS_5G" ] }, "partnerMetadata": { "description": "Informational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.", "$ref": "InterconnectAttachmentPartnerMetadata" }, "labels": { "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key\/value pair must comply with RFC1035. Label values may be empty.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.", "type": "string", "format": "byte" }, "state": { "description": "[Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED\/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. ", "type": "string", "enumDescriptions": [ "Indicates that attachment has been turned up and is ready to use.", "The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was wiped out, or because the other side of a Partner attachment was deleted.", "A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.", "PARTNER or PARTNER_PROVIDER attachment that is waiting for the customer to activate.", "A newly created PARTNER attachment that has not yet been configured on the Partner side.", "", "Indicates that attachment is not ready to use yet, because turnup is not complete." ], "enum": [ "ACTIVE", "DEFUNCT", "PARTNER_REQUEST_RECEIVED", "PENDING_CUSTOMER", "PENDING_PARTNER", "STATE_UNSPECIFIED", "UNPROVISIONED" ] }, "partnerAsn": { "description": "Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.", "type": "string", "format": "int64" }, "encryption": { "description": "Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use HA VPN over Cloud Interconnect, the VLAN attachment must be created with this option. ", "type": "string", "enumDescriptions": [ "The interconnect attachment will carry only encrypted traffic that is encrypted by an IPsec device such as HA VPN gateway; VMs cannot directly send traffic to or receive traffic from such an interconnect attachment. To use HA VPN over Cloud Interconnect, the interconnect attachment must be created with this option.", "This is the default value, which means the Interconnect Attachment will carry unencrypted traffic. VMs will be able to send traffic to or receive traffic from such interconnect attachment." ], "enum": [ "IPSEC", "NONE" ] }, "ipsecInternalAddresses": { "description": "A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool.", "type": "array", "items": { "type": "string" } }, "dataplaneVersion": { "description": "[Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1.", "type": "integer", "format": "int32" }, "satisfiesPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "stackType": { "description": "The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations.", "type": "string", "enumDescriptions": [ "The interconnect attachment can have both IPv4 and IPv6 addresses.", "The interconnect attachment will only be assigned IPv4 addresses." ], "enum": [ "IPV4_IPV6", "IPV4_ONLY" ] }, "cloudRouterIpv6Address": { "description": "[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.", "type": "string" }, "customerRouterIpv6Address": { "description": "[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.", "type": "string" }, "candidateIpv6Subnets": { "description": "This field is not available.", "type": "array", "items": { "type": "string" } }, "cloudRouterIpv6InterfaceId": { "description": "This field is not available.", "type": "string" }, "customerRouterIpv6InterfaceId": { "description": "This field is not available.", "type": "string" }, "subnetLength": { "description": "Input only. Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility. ", "type": "integer", "format": "int32" }, "remoteService": { "description": "[Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider. Example values: \"Amazon Web Services\" \"Microsoft Azure\". The field is set only for attachments on Cross-Cloud Interconnect connections. Its value is copied from the InterconnectRemoteLocation remoteService field.", "type": "string" }, "configurationConstraints": { "description": "[Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.", "$ref": "InterconnectAttachmentConfigurationConstraints" } } }, "InterconnectAttachmentPrivateInfo": { "id": "InterconnectAttachmentPrivateInfo", "description": "Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED.", "type": "object", "properties": { "tag8021q": { "description": "[Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.", "type": "integer", "format": "uint32" } } }, "InterconnectAttachmentPartnerMetadata": { "id": "InterconnectAttachmentPartnerMetadata", "description": "Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments.", "type": "object", "properties": { "partnerName": { "description": "Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.", "type": "string" }, "interconnectName": { "description": "Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance \"Chicago 1\". This value may be validated to match approved Partner values.", "type": "string" }, "portalUrl": { "description": "URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.", "type": "string" } } }, "InterconnectAttachmentConfigurationConstraints": { "id": "InterconnectAttachmentConfigurationConstraints", "type": "object", "properties": { "bgpMd5": { "description": "[Output Only] Whether the attachment's BGP session requires\/allows\/disallows BGP MD5 authentication. This can take one of the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED. For example, a Cross-Cloud Interconnect connection to a remote cloud provider that requires BGP MD5 authentication has the interconnectRemoteLocation attachment_configuration_constraints.bgp_md5 field set to MD5_REQUIRED, and that property is propagated to the attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is returned if MD5 is requested.", "type": "string", "enumDescriptions": [ "MD5_OPTIONAL: BGP MD5 authentication is supported and can optionally be configured.", "MD5_REQUIRED: BGP MD5 authentication must be configured.", "MD5_UNSUPPORTED: BGP MD5 authentication must not be configured" ], "enum": [ "MD5_OPTIONAL", "MD5_REQUIRED", "MD5_UNSUPPORTED" ] }, "bgpPeerAsnRanges": { "description": "[Output Only] List of ASN ranges that the remote location is known to support. Formatted as an array of inclusive ranges {min: min-value, max: max-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}] allows the peer ASN to be 123 or anything in the range 64512-65534. This field is only advisory. Although the API accepts other ranges, these are the ranges that we recommend.", "type": "array", "items": { "$ref": "InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange" } } } }, "InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange": { "id": "InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange", "type": "object", "properties": { "min": { "type": "integer", "format": "uint32" }, "max": { "type": "integer", "format": "uint32" } } }, "InterconnectAttachmentAggregatedList": { "id": "InterconnectAttachmentAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.", "default": "compute#interconnectAttachmentAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InterconnectAttachmentsScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of interconnect attachments.", "$ref": "InterconnectAttachmentsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "InterconnectAttachmentsScopedList": { "id": "InterconnectAttachmentsScopedList", "type": "object", "properties": { "interconnectAttachments": { "description": "A list of interconnect attachments contained in this scope.", "type": "array", "items": { "$ref": "InterconnectAttachment" } }, "warning": { "description": "Informational warning which replaces the list of addresses when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Interconnect": { "id": "Interconnect", "description": "Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#interconnect for interconnects.", "default": "compute#interconnect", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.interconnects.insert" ] }, "type": "string" }, "location": { "description": "URL of the InterconnectLocation object that represents where this connection is to be provisioned.", "type": "string" }, "linkType": { "description": "Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.", "type": "string", "enumDescriptions": [ "100G Ethernet, LR Optics.", "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" ], "enum": [ "LINK_TYPE_ETHERNET_100G_LR", "LINK_TYPE_ETHERNET_10G_LR" ] }, "requestedLinkCount": { "description": "Target number of physical links in the link bundle, as requested by the customer.", "type": "integer", "format": "int32" }, "interconnectType": { "description": "Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.", "type": "string", "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." ], "enum": [ "DEDICATED", "IT_PRIVATE", "PARTNER" ] }, "adminEnabled": { "description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.", "type": "boolean" }, "nocContactEmail": { "description": "Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation.", "type": "string" }, "customerName": { "description": "Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.", "type": "string" }, "operationalStatus": { "description": "[Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. ", "type": "string", "enumDescriptions": [ "The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.", "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect." ], "enum": [ "OS_ACTIVE", "OS_UNPROVISIONED" ] }, "provisionedLinkCount": { "description": "[Output Only] Number of links actually provisioned in this interconnect.", "type": "integer", "format": "int32" }, "interconnectAttachments": { "description": "[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.", "type": "array", "items": { "type": "string" } }, "peerIpAddress": { "description": "[Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.", "type": "string" }, "googleIpAddress": { "description": "[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.", "type": "string" }, "googleReferenceId": { "description": "[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.", "type": "string" }, "expectedOutages": { "description": "[Output Only] A list of outages expected for this Interconnect.", "type": "array", "items": { "$ref": "InterconnectOutageNotification" } }, "circuitInfos": { "description": "[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.", "type": "array", "items": { "$ref": "InterconnectCircuitInfo" } }, "labels": { "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key\/value pair must comply with RFC1035. Label values may be empty.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect.", "type": "string", "format": "byte" }, "state": { "description": "[Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. ", "type": "string", "enumDescriptions": [ "The interconnect is valid, turned up, and ready to use. Attachments may be provisioned on this interconnect.", "The interconnect has not completed turnup. No attachments may be provisioned on this interconnect." ], "enum": [ "ACTIVE", "UNPROVISIONED" ] }, "satisfiesPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "macsec": { "description": "Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router.", "$ref": "InterconnectMacsec" }, "macsecEnabled": { "description": "Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.", "type": "boolean" }, "remoteLocation": { "description": "Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.", "type": "string" }, "requestedFeatures": { "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Media Access Control security (MACsec)" ], "enum": [ "IF_MACSEC" ] } }, "availableFeatures": { "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Media Access Control security (MACsec)" ], "enum": [ "IF_MACSEC" ] } } } }, "InterconnectOutageNotification": { "id": "InterconnectOutageNotification", "description": "Description of a planned outage on this Interconnect.", "type": "object", "properties": { "name": { "description": "Unique identifier for this outage notification.", "type": "string" }, "description": { "description": "A description about the purpose of the outage.", "type": "string" }, "source": { "description": "The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.", "type": "string", "enumDescriptions": [ "This notification was generated by Google.", "[Deprecated] This notification was generated by Google." ], "enum": [ "GOOGLE", "NSRC_GOOGLE" ] }, "state": { "description": "State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with \"NS_\" have been deprecated in favor of the unprefixed values.", "type": "string", "enumDescriptions": [ "This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.", "The outage associated with this notification was cancelled before the outage was due to start.", "The outage associated with this notification is complete.", "[Deprecated] This outage notification is active. The event could be in the future, present, or past. See start_time and end_time for scheduling.", "[Deprecated] The outage associated with this notification was canceled before the outage was due to start." ], "enum": [ "ACTIVE", "CANCELLED", "COMPLETED", "NS_ACTIVE", "NS_CANCELED" ] }, "issueType": { "description": "Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with \"IT_\" have been deprecated in favor of the unprefixed values.", "type": "string", "enumDescriptions": [ "[Deprecated] The Interconnect may be completely out of service for some or all of the specified window.", "[Deprecated] Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth.", "The Interconnect may be completely out of service for some or all of the specified window.", "Some circuits comprising the Interconnect will be out of service during the expected window. The interconnect as a whole should remain up, albeit with reduced bandwidth." ], "enum": [ "IT_OUTAGE", "IT_PARTIAL_OUTAGE", "OUTAGE", "PARTIAL_OUTAGE" ] }, "affectedCircuits": { "description": "If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.", "type": "array", "items": { "type": "string" } }, "startTime": { "description": "Scheduled start time for the outage (milliseconds since Unix epoch).", "type": "string", "format": "int64" }, "endTime": { "description": "Scheduled end time for the outage (milliseconds since Unix epoch).", "type": "string", "format": "int64" } } }, "InterconnectCircuitInfo": { "id": "InterconnectCircuitInfo", "description": "Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only.", "type": "object", "properties": { "googleCircuitId": { "description": "Google-assigned unique ID for this circuit. Assigned at circuit turn-up.", "type": "string" }, "googleDemarcId": { "description": "Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.", "type": "string" }, "customerDemarcId": { "description": "Customer-side demarc ID for this circuit.", "type": "string" } } }, "InterconnectMacsec": { "id": "InterconnectMacsec", "description": "Configuration information for enabling Media Access Control security (MACsec) on this Cloud Interconnect connection between Google and your on-premises router.", "type": "object", "properties": { "preSharedKeys": { "description": "Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN\/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", "type": "array", "items": { "$ref": "InterconnectMacsecPreSharedKey" } }, "failOpen": { "description": "If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.", "type": "boolean" } } }, "InterconnectMacsecPreSharedKey": { "id": "InterconnectMacsecPreSharedKey", "description": "Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode.", "type": "object", "properties": { "name": { "description": "Required. A name for this pre-shared key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "type": "string" }, "startTime": { "description": "A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart.", "type": "string" } } }, "InterconnectList": { "id": "InterconnectList", "description": "Response to the list request, and contains a list of interconnects.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.", "default": "compute#interconnectList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Interconnect resources.", "type": "array", "items": { "$ref": "Interconnect" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InterconnectsGetDiagnosticsResponse": { "id": "InterconnectsGetDiagnosticsResponse", "description": "Response for the InterconnectsGetDiagnosticsRequest.", "type": "object", "properties": { "result": { "$ref": "InterconnectDiagnostics" } } }, "InterconnectDiagnostics": { "id": "InterconnectDiagnostics", "description": "Diagnostics information about the Interconnect connection, which contains detailed and current technical information about Google's side of the connection.", "type": "object", "properties": { "macAddress": { "description": "The MAC address of the Interconnect's bundle interface.", "type": "string" }, "arpCaches": { "description": "A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled.", "type": "array", "items": { "$ref": "InterconnectDiagnosticsARPEntry" } }, "links": { "description": "A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.", "type": "array", "items": { "$ref": "InterconnectDiagnosticsLinkStatus" } }, "bundleOperationalStatus": { "description": "The operational status of the bundle interface.", "type": "string", "enumDescriptions": [ "If bundleAggregationType is LACP: LACP is not established and\/or all links in the bundle have DOWN operational status. If bundleAggregationType is STATIC: one or more links in the bundle has DOWN operational status.", "If bundleAggregationType is LACP: LACP is established and at least one link in the bundle has UP operational status. If bundleAggregationType is STATIC: all links in the bundle (typically just one) have UP operational status." ], "enum": [ "BUNDLE_OPERATIONAL_STATUS_DOWN", "BUNDLE_OPERATIONAL_STATUS_UP" ] }, "bundleAggregationType": { "description": "The aggregation type of the bundle interface.", "type": "string", "enumDescriptions": [ "LACP is enabled.", "LACP is disabled." ], "enum": [ "BUNDLE_AGGREGATION_TYPE_LACP", "BUNDLE_AGGREGATION_TYPE_STATIC" ] } } }, "InterconnectDiagnosticsARPEntry": { "id": "InterconnectDiagnosticsARPEntry", "description": "Describing the ARP neighbor entries seen on this link", "type": "object", "properties": { "macAddress": { "description": "The MAC address of this ARP neighbor.", "type": "string" }, "ipAddress": { "description": "The IP address of this ARP neighbor.", "type": "string" } } }, "InterconnectDiagnosticsLinkStatus": { "id": "InterconnectDiagnosticsLinkStatus", "type": "object", "properties": { "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" }, "receivingOpticalPower": { "description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level.", "$ref": "InterconnectDiagnosticsLinkOpticalPower" }, "transmittingOpticalPower": { "description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level.", "$ref": "InterconnectDiagnosticsLinkOpticalPower" }, "lacpStatus": { "$ref": "InterconnectDiagnosticsLinkLACPStatus" }, "operationalStatus": { "description": "The operational status of the link.", "type": "string", "enumDescriptions": [ "The interface is unable to communicate with the remote end.", "The interface has low level communication with the remote end." ], "enum": [ "LINK_OPERATIONAL_STATUS_DOWN", "LINK_OPERATIONAL_STATUS_UP" ] }, "arpCaches": { "description": "A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled", "type": "array", "items": { "$ref": "InterconnectDiagnosticsARPEntry" } }, "macsec": { "description": "Describes the status of MACsec encryption on this link.", "$ref": "InterconnectDiagnosticsMacsecStatus" } } }, "InterconnectDiagnosticsLinkOpticalPower": { "id": "InterconnectDiagnosticsLinkOpticalPower", "type": "object", "properties": { "value": { "description": "Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.", "type": "number", "format": "float" }, "state": { "description": "The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: - OK: The value has not crossed a warning threshold. - LOW_WARNING: The value has crossed below the low warning threshold. - HIGH_WARNING: The value has crossed above the high warning threshold. - LOW_ALARM: The value has crossed below the low alarm threshold. - HIGH_ALARM: The value has crossed above the high alarm threshold. ", "type": "string", "enumDescriptions": [ "The value has crossed above the high alarm threshold.", "The value of the current optical power has crossed above the high warning threshold.", "The value of the current optical power has crossed below the low alarm threshold.", "The value of the current optical power has crossed below the low warning threshold.", "The value of the current optical power has not crossed a warning threshold." ], "enum": [ "HIGH_ALARM", "HIGH_WARNING", "LOW_ALARM", "LOW_WARNING", "OK" ] } } }, "InterconnectDiagnosticsLinkLACPStatus": { "id": "InterconnectDiagnosticsLinkLACPStatus", "type": "object", "properties": { "state": { "description": "The state of a LACP link, which can take one of the following values: - ACTIVE: The link is configured and active within the bundle. - DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty. ", "type": "string", "enumDescriptions": [ "The link is configured and active within the bundle.", "The link is not configured within the bundle, this means the rest of the object should be empty." ], "enum": [ "ACTIVE", "DETACHED" ] }, "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" } } }, "InterconnectDiagnosticsMacsecStatus": { "id": "InterconnectDiagnosticsMacsecStatus", "description": "Describes the status of MACsec encryption on the link.", "type": "object", "properties": { "operational": { "description": "Indicates whether or not MACsec is operational on this link.", "type": "boolean" }, "ckn": { "description": "Indicates the Connectivity Association Key Name (CKN) currently being used if MACsec is operational.", "type": "string" } } }, "InterconnectsGetMacsecConfigResponse": { "id": "InterconnectsGetMacsecConfigResponse", "description": "Response for the InterconnectsGetMacsecConfigRequest.", "type": "object", "properties": { "result": { "$ref": "InterconnectMacsecConfig" }, "etag": { "description": "end_interface: MixerGetResponseWithEtagBuilder", "type": "string" } } }, "InterconnectMacsecConfig": { "id": "InterconnectMacsecConfig", "description": "MACsec configuration information for the Interconnect connection. Contains the generated Connectivity Association Key Name (CKN) and the key (CAK) for this Interconnect connection.", "type": "object", "properties": { "preSharedKeys": { "description": "A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN\/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", "type": "array", "items": { "$ref": "InterconnectMacsecConfigPreSharedKey" } } } }, "InterconnectMacsecConfigPreSharedKey": { "id": "InterconnectMacsecConfigPreSharedKey", "description": "Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode.", "type": "object", "properties": { "name": { "description": "User provided name for this pre-shared key.", "type": "string" }, "ckn": { "description": "An auto-generated Connectivity Association Key Name (CKN) for this key.", "type": "string" }, "cak": { "description": "An auto-generated Connectivity Association Key (CAK) for this key.", "type": "string" }, "startTime": { "description": "User provided timestamp on or after which this key is valid.", "type": "string" } } }, "ExternalVpnGateway": { "id": "ExternalVpnGateway", "description": "Represents an external VPN gateway. External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, you must create a external VPN gateway resource with information about the other gateway. For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.", "default": "compute#externalVpnGateway", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.externalVpnGateways.insert" ] }, "type": "string" }, "redundancyType": { "description": "Indicates the user-supplied redundancy type of this external VPN gateway.", "type": "string", "enumDescriptions": [ "The external VPN gateway has four public IP addresses; at the time of writing this API, the AWS virtual private gateway is an example which has four public IP addresses for high availability connections; there should be two VPN connections in the AWS virtual private gateway , each AWS VPN connection has two public IP addresses; please make sure to put two public IP addresses from one AWS VPN connection into interfaces 0 and 1 of this external VPN gateway, and put the other two public IP addresses from another AWS VPN connection into interfaces 2 and 3 of this external VPN gateway. When displaying highly available configuration status for the VPN tunnels connected to FOUR_IPS_REDUNDANCY external VPN gateway, Google will always detect whether interfaces 0 and 1 are connected on one interface of HA Cloud VPN gateway, and detect whether interfaces 2 and 3 are connected to another interface of the HA Cloud VPN gateway.", "The external VPN gateway has only one public IP address which internally provide redundancy or failover.", "The external VPN gateway has two public IP addresses which are redundant with each other, the following two types of setup on your on-premises side would have this type of redundancy: (1) Two separate on-premises gateways, each with one public IP address, the two on-premises gateways are redundant with each other. (2) A single on-premise gateway with two public IP addresses that are redundant with eatch other." ], "enum": [ "FOUR_IPS_REDUNDANCY", "SINGLE_IP_INTERNALLY_REDUNDANT", "TWO_IPS_REDUNDANCY" ] }, "interfaces": { "description": "A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.", "type": "array", "items": { "$ref": "ExternalVpnGatewayInterface" } }, "labels": { "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key\/value pair must comply with RFC1035. Label values may be empty.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.", "type": "string", "format": "byte" } } }, "ExternalVpnGatewayInterface": { "id": "ExternalVpnGatewayInterface", "description": "The interface for the external VPN gateway.", "type": "object", "properties": { "id": { "description": "The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: - SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3 ", "type": "integer", "format": "uint32" }, "ipAddress": { "description": "IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.", "type": "string" }, "ipv6Address": { "description": "IPv6 address of the interface in the external VPN gateway. This IPv6 address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine. Must specify an IPv6 address (not IPV4-mapped) using any format described in RFC 4291 (e.g. 2001:db8:0:0:2d9:51:0:0). The output format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).", "type": "string" } } }, "ExternalVpnGatewayList": { "id": "ExternalVpnGatewayList", "description": "Response to the list request, and contains a list of externalVpnGateways.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways.", "default": "compute#externalVpnGatewayList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of ExternalVpnGateway resources.", "type": "array", "items": { "$ref": "ExternalVpnGateway" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "etag": { "type": "string" } } }, "ForwardingRuleList": { "id": "ForwardingRuleList", "description": "Contains a list of ForwardingRule resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#forwardingRuleList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of ForwardingRule resources.", "type": "array", "items": { "$ref": "ForwardingRule" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "ForwardingRule": { "id": "ForwardingRule", "description": "Represents a Forwarding Rule resource. Forwarding rule resources in Google Cloud can be either regional or global in scope: * [Global](https:\/\/cloud.google.com\/compute\/docs\/reference\/rest\/v2\/globalForwardingRules) * [Regional](https:\/\/cloud.google.com\/compute\/docs\/reference\/rest\/v2\/forwardingRules) A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#forwardingRule for forwarding rule resources.", "default": "compute#forwardingRule", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "IPAddress": { "description": "IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::\/96` * Full resource URL, as in https:\/\/www.googleapis.com\/compute\/v1\/projects\/ project_id\/regions\/region\/addresses\/address-name * Partial URL or by name, as in: - projects\/project_id\/regions\/region\/addresses\/address-name - regions\/region\/addresses\/address-name - global\/addresses\/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https:\/\/cloud.google.com\/load-balancing\/docs\/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number.", "type": "string" }, "IPProtocol": { "description": "The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https:\/\/cloud.google.com\/load-balancing\/docs\/features#protocols_from_the_load_balancer_to_the_backends).", "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "" ], "enum": [ "AH", "ESP", "ICMP", "L3_DEFAULT", "SCTP", "TCP", "UDP" ] }, "portRange": { "description": "The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The portRange field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN. - Some products have restrictions on what ports can be used. See port specifications for details. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\\\d+(?:-\\\\d+)?", "type": "string" }, "ports": { "description": "The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding. - You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair if they share at least one port number. @pattern: \\\\d+(?:-\\\\d+)?", "type": "array", "items": { "type": "string" } }, "target": { "description": "The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the \"Target\" column in [Port specifications](https:\/\/cloud.google.com\/load-balancing\/docs\/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - 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" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "loadBalancingScheme": { "description": "Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.", "type": "string", "enumDescriptions": [ "", "", "", "", "", "" ], "enum": [ "EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED", "INTERNAL_SELF_MANAGED", "INVALID" ] }, "subnetwork": { "description": "This field identifies the subnetwork that the load balanced IP should belong to for this forwarding rule, used with internal load balancers and external passthrough Network Load Balancers with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.", "type": "string" }, "network": { "description": "This field is not used for global external load balancing. For internal passthrough Network Load Balancers, this field identifies the network that the load balanced IP should belong to for this forwarding rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.", "type": "string" }, "backendService": { "description": "Identifies the backend service to which the forwarding rule sends traffic. Required for internal and external passthrough Network Load Balancers; must be omitted for all other load balancer types.", "type": "string" }, "serviceDirectoryRegistrations": { "description": "Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.", "type": "array", "items": { "$ref": "ForwardingRuleServiceDirectoryRegistration" } }, "serviceLabel": { "description": "An optional prefix to the service name for this forwarding rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "serviceName": { "description": "[Output Only] The internal fully qualified service name for this forwarding rule. This field is only used for internal load balancing.", "type": "string" }, "networkTier": { "description": "This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address.", "type": "string", "enumDescriptions": [ "Public internet quality with fixed bandwidth.", "High quality, Google-grade network tier, support for all networking products.", "Public internet quality, only limited support for other networking products.", "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured." ], "enum": [ "FIXED_STANDARD", "PREMIUM", "STANDARD", "STANDARD_OVERRIDES_FIXED_STANDARD" ] }, "labels": { "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key\/value pair must comply with RFC1035. Label values may be empty.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.", "type": "string", "format": "byte" }, "ipVersion": { "description": "The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "IPV4", "IPV6", "UNSPECIFIED_VERSION" ] }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.", "type": "string", "format": "byte" }, "allPorts": { "description": "The ports, portRange, and allPorts fields are mutually exclusive. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The allPorts field has the following limitations: - It requires that the forwarding rule IPProtocol be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding. - Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires allPorts be set to true. ", "type": "boolean" }, "allowGlobalAccess": { "description": "If set to true, clients can access the internal passthrough Network Load Balancers, the regional internal Application Load Balancer, and the regional internal proxy Network Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created.", "type": "boolean" }, "metadataFilters": { "description": "Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.", "type": "array", "items": { "$ref": "MetadataFilter" } }, "isMirroringCollector": { "description": "Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL.", "type": "boolean" }, "sourceIpRanges": { "description": "If not empty, this forwarding rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a forwarding rule can only have up to 64 source IP ranges, and this field can only be used with a regional forwarding rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0\/24).", "type": "array", "items": { "type": "string" } }, "pscConnectionId": { "description": "[Output Only] The PSC connection id of the PSC forwarding rule.", "type": "string", "format": "uint64" }, "pscConnectionStatus": { "type": "string", "enumDescriptions": [ "The connection has been accepted by the producer.", "The connection has been closed by the producer and will not serve traffic going forward.", "The connection has been accepted by the producer, but the producer needs to 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.", "" ], "enum": [ "ACCEPTED", "CLOSED", "NEEDS_ATTENTION", "PENDING", "REJECTED", "STATUS_UNSPECIFIED" ] }, "baseForwardingRule": { "description": "[Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified.", "type": "string" }, "allowPscGlobalAccess": { "description": "This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.", "type": "boolean" }, "noAutomateDnsZone": { "description": "This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable.", "type": "boolean" }, "ipCollection": { "description": "Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in https:\/\/www.googleapis.com\/compute\/v1\/projects\/project_id\/regions\/region \/publicDelegatedPrefixes\/sub-pdp-name Partial URL, as in: - projects\/project_id\/regions\/region\/publicDelegatedPrefixes\/sub-pdp-name - regions\/region\/publicDelegatedPrefixes\/sub-pdp-name ", "type": "string" } } }, "ForwardingRuleServiceDirectoryRegistration": { "id": "ForwardingRuleServiceDirectoryRegistration", "description": "Describes the auto-registration of the forwarding rule to Service Directory. The region and project of the Service Directory resource generated from this registration will be the same as this forwarding rule.", "type": "object", "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 rule under. Default to \"us-central1\". Only used for PSC for Google APIs. All PSC for Google APIs forwarding rules on the same network should use the same Service Directory region.", "type": "string" } } }, "MetadataFilter": { "id": "MetadataFilter", "description": "Opaque filter criteria used by load balancers to restrict routing configuration to a limited set of load balancing proxies. Proxies and sidecars involved in load balancing would typically present metadata to the load balancers that need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. An example for using metadataFilters would be: if load balancing involves Envoys, they receive routing configuration when values in metadataFilters match values supplied in of their XDS requests to loadbalancers.", "type": "object", "properties": { "filterMatchCriteria": { "description": "Specifies how individual filter label matches within the list of filterLabels and contributes toward the overall metadataFilter match. Supported values are: - MATCH_ANY: at least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: all filterLabels must have matching labels in the provided metadata. ", "type": "string", "enumDescriptions": [ "Specifies that all filterLabels must match for the metadataFilter to be considered a match.", "Specifies that any filterLabel must match for the metadataFilter to be considered a match.", "Indicates that the match criteria was not set. A metadataFilter must never be created with this value." ], "enum": [ "MATCH_ALL", "MATCH_ANY", "NOT_SET" ] }, "filterLabels": { "description": "The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.", "type": "array", "items": { "$ref": "MetadataFilterLabelMatch" } } } }, "MetadataFilterLabelMatch": { "id": "MetadataFilterLabelMatch", "description": "MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the load balancer.", "type": "object", "properties": { "name": { "description": "Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.", "type": "string" }, "value": { "description": "The value of the label must match the specified value. value can have a maximum length of 1024 characters.", "type": "string" } } }, "TargetReference": { "id": "TargetReference", "type": "object", "properties": { "target": { "type": "string" } } }, "ForwardingRuleAggregatedList": { "id": "ForwardingRuleAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.", "default": "compute#forwardingRuleAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of ForwardingRulesScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of addresses.", "$ref": "ForwardingRulesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "ForwardingRulesScopedList": { "id": "ForwardingRulesScopedList", "type": "object", "properties": { "forwardingRules": { "description": "A list of forwarding rules contained in this scope.", "type": "array", "items": { "$ref": "ForwardingRule" } }, "warning": { "description": "Informational warning which replaces the list of forwarding rules when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "HealthCheckServicesList": { "id": "HealthCheckServicesList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices.", "default": "compute#healthCheckServicesList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of HealthCheckService resources.", "type": "array", "items": { "$ref": "HealthCheckService" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "HealthCheckService": { "id": "HealthCheckService", "description": "Represents a Health-Check as a Service resource.", "type": "object", "properties": { "kind": { "description": "[Output only] Type of the resource. Always compute#healthCheckServicefor health check services.", "default": "compute#healthCheckService", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "name": { "description": "Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "healthStatusAggregationPolicy": { "description": "Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService.", "type": "string", "enumDescriptions": [ "If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY.", "An EndpointHealth message is returned for each backend in the health check service." ], "enum": [ "AND", "NO_AGGREGATION" ] }, "healthChecks": { "description": "A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups.", "type": "array", "items": { "type": "string" } }, "networkEndpointGroups": { "description": "A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.", "type": "array", "items": { "type": "string" } }, "notificationEndpoints": { "description": "A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.", "type": "array", "items": { "type": "string" } }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch\/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.", "type": "string", "format": "byte" } } }, "HealthCheckList": { "id": "HealthCheckList", "description": "Contains a list of HealthCheck resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#healthCheckList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of HealthCheck resources.", "type": "array", "items": { "$ref": "HealthCheck" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "HealthCheck": { "id": "HealthCheck", "description": "Represents a health check resource. Google Compute Engine has two health check resources: * [Regional](\/compute\/docs\/reference\/rest\/v2\/regionHealthChecks) * [Global](\/compute\/docs\/reference\/rest\/v2\/healthChecks) These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). Load balancing Health check requirements vary depending on the type of load balancer. For details about the type of health check supported for each load balancer and corresponding backend type, see Health checks overview: Load balancer guide. Autohealing in MIGs The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview.", "type": "object", "properties": { "kind": { "description": "Type of the resource.", "default": "compute#healthCheck", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in 3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9][a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase 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" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "checkIntervalSec": { "description": "How often (in seconds) to send a health check. The default value is 5 seconds.", "type": "integer", "format": "int32" }, "timeoutSec": { "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.", "type": "integer", "format": "int32" }, "unhealthyThreshold": { "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.", "type": "integer", "format": "int32" }, "healthyThreshold": { "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.", "type": "integer", "format": "int32" }, "type": { "description": "Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.", "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "" ], "enum": [ "GRPC", "HTTP", "HTTP2", "HTTPS", "INVALID", "SSL", "TCP" ] }, "tcpHealthCheck": { "$ref": "TCPHealthCheck" }, "sslHealthCheck": { "$ref": "SSLHealthCheck" }, "httpHealthCheck": { "$ref": "HTTPHealthCheck" }, "httpsHealthCheck": { "$ref": "HTTPSHealthCheck" }, "http2HealthCheck": { "$ref": "HTTP2HealthCheck" }, "grpcHealthCheck": { "$ref": "GRPCHealthCheck" }, "sourceRegions": { "description": "The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing. ", "type": "array", "items": { "type": "string" } }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "region": { "description": "[Output Only] Region where the health check resides. Not applicable to global health checks.", "type": "string" }, "logConfig": { "description": "Configure logging on this health check.", "$ref": "HealthCheckLogConfig" } } }, "TCPHealthCheck": { "id": "TCPHealthCheck", "type": "object", "properties": { "port": { "description": "The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.", "type": "integer", "format": "int32" }, "portName": { "description": "Not supported.", "type": "string" }, "portSpecification": { "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.", "type": "string", "enumDescriptions": [ "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.", "Not supported.", "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports." ], "enum": [ "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT" ] }, "request": { "description": "Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.", "type": "string" }, "response": { "description": "Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https:\/\/cloud.google.com\/load-balancing\/docs\/health-check-concepts#criteria-protocol-ssl-tcp", "type": "string" }, "proxyHeader": { "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NONE", "PROXY_V1" ] } } }, "SSLHealthCheck": { "id": "SSLHealthCheck", "type": "object", "properties": { "port": { "description": "The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.", "type": "integer", "format": "int32" }, "portName": { "description": "Not supported.", "type": "string" }, "portSpecification": { "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.", "type": "string", "enumDescriptions": [ "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.", "Not supported.", "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports." ], "enum": [ "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT" ] }, "request": { "description": "Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection and SSL handshake.", "type": "string" }, "response": { "description": "Creates a content-based SSL health check. In addition to establishing a TCP connection and the TLS handshake, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https:\/\/cloud.google.com\/load-balancing\/docs\/health-check-concepts#criteria-protocol-ssl-tcp", "type": "string" }, "proxyHeader": { "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NONE", "PROXY_V1" ] } } }, "HTTPHealthCheck": { "id": "HTTPHealthCheck", "type": "object", "properties": { "port": { "description": "The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.", "type": "integer", "format": "int32" }, "portName": { "description": "Not supported.", "type": "string" }, "portSpecification": { "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Also supported in legacy HTTP health checks for target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.", "type": "string", "enumDescriptions": [ "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.", "Not supported.", "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports." ], "enum": [ "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT" ] }, "host": { "description": "The value of the host header in the HTTP health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https:\/\/cloud.google.com\/load-balancing\/docs\/health-check-concepts#hc-packet-dest", "type": "string" }, "requestPath": { "description": "The request path of the HTTP health check request. The default value is \/. Must comply with RFC3986.", "type": "string" }, "proxyHeader": { "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NONE", "PROXY_V1" ] }, "response": { "description": "Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https:\/\/cloud.google.com\/load-balancing\/docs\/health-check-concepts#criteria-protocol-http", "type": "string" } } }, "HTTPSHealthCheck": { "id": "HTTPSHealthCheck", "type": "object", "properties": { "port": { "description": "The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.", "type": "integer", "format": "int32" }, "portName": { "description": "Not supported.", "type": "string" }, "portSpecification": { "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.", "type": "string", "enumDescriptions": [ "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.", "Not supported.", "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports." ], "enum": [ "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT" ] }, "host": { "description": "The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https:\/\/cloud.google.com\/load-balancing\/docs\/health-check-concepts#hc-packet-dest", "type": "string" }, "requestPath": { "description": "The request path of the HTTPS health check request. The default value is \/. Must comply with RFC3986.", "type": "string" }, "proxyHeader": { "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NONE", "PROXY_V1" ] }, "response": { "description": "Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https:\/\/cloud.google.com\/load-balancing\/docs\/health-check-concepts#criteria-protocol-http", "type": "string" } } }, "HTTP2HealthCheck": { "id": "HTTP2HealthCheck", "type": "object", "properties": { "port": { "description": "The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.", "type": "integer", "format": "int32" }, "portName": { "description": "Not supported.", "type": "string" }, "portSpecification": { "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.", "type": "string", "enumDescriptions": [ "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.", "Not supported.", "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports." ], "enum": [ "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT" ] }, "host": { "description": "The value of the host header in the HTTP\/2 health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https:\/\/cloud.google.com\/load-balancing\/docs\/health-check-concepts#hc-packet-dest", "type": "string" }, "requestPath": { "description": "The request path of the HTTP\/2 health check request. The default value is \/. Must comply with RFC3986.", "type": "string" }, "proxyHeader": { "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NONE", "PROXY_V1" ] }, "response": { "description": "Creates a content-based HTTP\/2 health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https:\/\/cloud.google.com\/load-balancing\/docs\/health-check-concepts#criteria-protocol-http", "type": "string" } } }, "GRPCHealthCheck": { "id": "GRPCHealthCheck", "type": "object", "properties": { "port": { "description": "The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.", "type": "integer", "format": "int32" }, "portName": { "description": "Not supported.", "type": "string" }, "portSpecification": { "description": "Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports.", "type": "string", "enumDescriptions": [ "The port number in the health check's port is used for health checking. Applies to network endpoint group and instance group backends.", "Not supported.", "For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service's named port defined in the instance group's named ports." ], "enum": [ "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT" ] }, "grpcServiceName": { "description": "The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII.", "type": "string" } } }, "HealthCheckLogConfig": { "id": "HealthCheckLogConfig", "description": "Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver.", "type": "object", "properties": { "enable": { "description": "Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.", "type": "boolean" } } }, "HealthChecksAggregatedList": { "id": "HealthChecksAggregatedList", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#healthChecksAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of HealthChecksScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of HealthChecks.", "$ref": "HealthChecksScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "HealthChecksScopedList": { "id": "HealthChecksScopedList", "type": "object", "properties": { "healthChecks": { "description": "A list of HealthChecks contained in this scope.", "type": "array", "items": { "$ref": "HealthCheck" } }, "warning": { "description": "Informational warning which replaces the list of backend services when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "HttpHealthCheckList": { "id": "HttpHealthCheckList", "description": "Contains a list of HttpHealthCheck resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#httpHealthCheckList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of HttpHealthCheck resources.", "type": "array", "items": { "$ref": "HttpHealthCheck" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "HttpHealthCheck": { "id": "HttpHealthCheck", "description": "Represents a legacy HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.", "default": "compute#httpHealthCheck", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "host": { "description": "The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.", "type": "string" }, "requestPath": { "description": "The request path of the HTTP health check request. The default value is \/. This field does not support query parameters. Must comply with RFC3986.", "type": "string" }, "port": { "description": "The TCP port number for the HTTP health check request. The default value is 80.", "type": "integer", "format": "int32" }, "checkIntervalSec": { "description": "How often (in seconds) to send a health check. The default value is 5 seconds.", "type": "integer", "format": "int32" }, "timeoutSec": { "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.", "type": "integer", "format": "int32" }, "unhealthyThreshold": { "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.", "type": "integer", "format": "int32" }, "healthyThreshold": { "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.", "type": "integer", "format": "int32" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" } } }, "HttpsHealthCheckList": { "id": "HttpsHealthCheckList", "description": "Contains a list of HttpsHealthCheck resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#httpsHealthCheckList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of HttpsHealthCheck resources.", "type": "array", "items": { "$ref": "HttpsHealthCheck" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "HttpsHealthCheck": { "id": "HttpsHealthCheck", "description": "Represents a legacy HTTPS Health Check resource. Legacy HTTPS health checks have been deprecated. If you are using a target pool-based network load balancer, you must use a legacy HTTP (not HTTPS) health check. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .", "type": "object", "properties": { "kind": { "description": "Type of the resource.", "default": "compute#httpsHealthCheck", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "host": { "description": "The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.", "type": "string" }, "requestPath": { "description": "The request path of the HTTPS health check request. The default value is \"\/\". Must comply with RFC3986.", "type": "string" }, "port": { "description": "The TCP port number for the HTTPS health check request. The default value is 443.", "type": "integer", "format": "int32" }, "checkIntervalSec": { "description": "How often (in seconds) to send a health check. The default value is 5 seconds.", "type": "integer", "format": "int32" }, "timeoutSec": { "description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.", "type": "integer", "format": "int32" }, "unhealthyThreshold": { "description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.", "type": "integer", "format": "int32" }, "healthyThreshold": { "description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.", "type": "integer", "format": "int32" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" } } }, "InstanceTemplateList": { "id": "InstanceTemplateList", "description": "A list of instance templates.", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.", "default": "compute#instanceTemplateList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InstanceTemplate resources.", "type": "array", "items": { "$ref": "InstanceTemplate" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InstanceTemplate": { "id": "InstanceTemplate", "description": "Represents an Instance Template resource. Google Compute Engine has two Instance Template resources: [Global](\/compute\/docs\/reference\/rest\/v2\/instanceTemplates) * [Regional](\/compute\/docs\/reference\/rest\/v2\/regionInstanceTemplates) You can reuse a global instance template in different regions whereas you can use a regional instance template in a specified region only. If you want to reduce cross-region dependency or achieve data residency, use a regional instance template. To create VMs, managed instance groups, and reservations, you can use either global or regional instance templates. For more information, read Instance Templates.", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.", "default": "compute#instanceTemplate", "type": "string" }, "id": { "description": "[Output Only] A unique identifier for this instance template. The server defines this identifier.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] The creation timestamp for this instance template in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.instanceTemplates.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "properties": { "description": "The instance properties for this instance template.", "$ref": "InstanceProperties" }, "selfLink": { "description": "[Output Only] The URL for this instance template. The server defines this URL.", "type": "string" }, "sourceInstance": { "description": "The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/instances\/instance - projects\/project\/zones\/zone\/instances\/instance ", "type": "string" }, "sourceInstanceParams": { "description": "The source instance params to use to create this instance template.", "$ref": "SourceInstanceParams" }, "region": { "description": "[Output Only] URL of the region where the instance template resides. Only applicable for regional resources.", "type": "string" } } }, "SourceInstanceParams": { "id": "SourceInstanceParams", "description": "A specification of the parameters to use when creating the instance template from a source instance.", "type": "object", "properties": { "diskConfigs": { "description": "Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R\/W disks, the source images for each disk will be used. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.", "type": "array", "items": { "$ref": "DiskInstantiationConfig" } } } }, "DiskInstantiationConfig": { "id": "DiskInstantiationConfig", "description": "A specification of the desired way to instantiate a disk in the instance template when its created from a source instance.", "type": "object", "properties": { "deviceName": { "description": "Specifies the device name of the disk to which the configurations apply to.", "type": "string" }, "instantiateFrom": { "description": "Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks. ", "type": "string", "enumDescriptions": [ "Attach the existing disk in read-only mode. The request will fail if the disk was attached in read-write mode on the source instance. Applicable to: read-only disks.", "Create a blank disk. The disk will be created unformatted. Applicable to: additional read-write disks, local SSDs.", "Use the custom image specified in the custom_image field. Applicable to: boot disk, additional read-write disks.", "Use the default instantiation option for the corresponding type of disk. For boot disk and any other R\/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.", "Do not include the disk in the instance template. Applicable to: additional read-write disks, local SSDs, read-only disks.", "Use the same source image used for creation of the source instance's corresponding disk. The request will fail if the source VM's disk was created from a snapshot. Applicable to: boot disk, additional read-write disks.", "Use the same source image family used for creation of the source instance's corresponding disk. The request will fail if the source image of the source disk does not belong to any image family. Applicable to: boot disk, additional read-write disks." ], "enum": [ "ATTACH_READ_ONLY", "BLANK", "CUSTOM_IMAGE", "DEFAULT", "DO_NOT_INCLUDE", "SOURCE_IMAGE", "SOURCE_IMAGE_FAMILY" ] }, "autoDelete": { "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).", "type": "boolean" }, "customImage": { "description": "The custom source image to be used to restore this disk when instantiating this instance template.", "type": "string" } } }, "InstanceTemplateAggregatedList": { "id": "InstanceTemplateAggregatedList", "description": "Contains a list of InstanceTemplatesScopedList.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#instanceTemplateAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InstanceTemplatesScopedList resources.", "type": "object", "additionalProperties": { "description": "The name of the scope that contains this set of instance templates.", "$ref": "InstanceTemplatesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InstanceTemplatesScopedList": { "id": "InstanceTemplatesScopedList", "type": "object", "properties": { "instanceTemplates": { "description": "[Output Only] A list of instance templates that are contained within the specified project and zone.", "type": "array", "items": { "$ref": "InstanceTemplate" } }, "warning": { "description": "[Output Only] An informational warning that replaces the list of instance templates when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InstanceSettings": { "id": "InstanceSettings", "description": "Represents a Instance Settings resource. You can use instance settings to configure default settings for Compute Engine VM instances. For example, you can use it to configure default machine type of Compute Engine VM instances.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#instance_settings for instance settings.", "default": "compute#instanceSettings", "type": "string" }, "fingerprint": { "description": "Specifies a fingerprint for instance settings, which is essentially a hash of the instance settings resource's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance settings resource. You must always provide an up-to-date fingerprint hash in order to update or change the resource, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource.", "type": "string", "format": "byte" }, "metadata": { "description": "The metadata key\/value pairs assigned to all the instances in the corresponding scope.", "$ref": "InstanceSettingsMetadata" }, "zone": { "description": "[Output Only] URL of the zone where the resource resides You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" } } }, "InstanceSettingsMetadata": { "id": "InstanceSettingsMetadata", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#metadata for metadata.", "default": "compute#metadata", "type": "string" }, "items": { "description": "A metadata key\/value items map. The total size of all keys and values must be less than 512KB.", "type": "object", "additionalProperties": { "type": "string" } } } }, "InstantSnapshotList": { "id": "InstantSnapshotList", "description": "Contains a list of InstantSnapshot resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#instantSnapshotList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InstantSnapshot resources.", "type": "array", "items": { "$ref": "InstantSnapshot" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InstantSnapshot": { "id": "InstantSnapshot", "description": "Represents a InstantSnapshot resource. You can use instant snapshots to create disk rollback points quickly..", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#instantSnapshot for InstantSnapshot resources.", "default": "compute#instantSnapshot", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "status": { "description": "[Output Only] The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.", "type": "string", "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 Disk restoration" ], "enum": [ "CREATING", "DELETING", "FAILED", "READY", "UNAVAILABLE" ] }, "sourceDisk": { "description": "URL of the source disk used to create this instant snapshot. Note that the source disk must be in the same zone\/region as the instant snapshot to be created. This can be a full or valid partial URL. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/disks\/disk - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/regions\/region \/disks\/disk - projects\/project\/zones\/zone\/disks\/disk - projects\/project\/regions\/region\/disks\/disk - zones\/zone\/disks\/disk - regions\/region\/disks\/disk ", "type": "string" }, "sourceDiskId": { "description": "[Output Only] The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.", "type": "string" }, "diskSizeGb": { "description": "[Output Only] Size of the source disk, specified in GB.", "type": "string", "format": "int64" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource's resource id.", "type": "string" }, "labels": { "description": "Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method. Label values may be empty.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a InstantSnapshot.", "type": "string", "format": "byte" }, "zone": { "description": "[Output Only] URL of the zone where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the instant snapshot resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "satisfiesPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "architecture": { "description": "[Output Only] The architecture of the instant snapshot. Valid values are ARM64 or X86_64.", "type": "string", "enumDescriptions": [ "Default value indicating Architecture is not set.", "Machines with architecture ARM64", "Machines with architecture X86_64" ], "enum": [ "ARCHITECTURE_UNSPECIFIED", "ARM64", "X86_64" ] }, "resourceStatus": { "description": "[Output Only] Status information for the instant snapshot resource.", "$ref": "InstantSnapshotResourceStatus" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" } } }, "InstantSnapshotResourceStatus": { "id": "InstantSnapshotResourceStatus", "type": "object", "properties": { "storageSizeBytes": { "description": "[Output Only] The storage size of this instant snapshot.", "type": "string", "format": "int64" } } }, "InstantSnapshotAggregatedList": { "id": "InstantSnapshotAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#instantSnapshotAggregatedList for aggregated lists of instantSnapshots.", "default": "compute#instantSnapshotAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InstantSnapshotsScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of instantSnapshots.", "$ref": "InstantSnapshotsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "InstantSnapshotsScopedList": { "id": "InstantSnapshotsScopedList", "type": "object", "properties": { "instantSnapshots": { "description": "[Output Only] A list of instantSnapshots contained in this scope.", "type": "array", "items": { "$ref": "InstantSnapshot" } }, "warning": { "description": "[Output Only] Informational warning which replaces the list of instantSnapshots when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InterconnectLocationList": { "id": "InterconnectLocationList", "description": "Response to the list request, and contains a list of interconnect locations.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations.", "default": "compute#interconnectLocationList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InterconnectLocation resources.", "type": "array", "items": { "$ref": "InterconnectLocation" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InterconnectLocation": { "id": "InterconnectLocation", "description": "Represents an Interconnect Attachment (VLAN) Location resource. You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.", "default": "compute#interconnectLocation", "type": "string" }, "description": { "description": "[Output Only] An optional description of the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "[Output Only] Name of the resource.", "type": "string" }, "peeringdbFacilityId": { "description": "[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).", "type": "string" }, "address": { "description": "[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.", "type": "string" }, "facilityProvider": { "description": "[Output Only] The name of the provider for this facility (e.g., EQUINIX).", "type": "string" }, "facilityProviderFacilityId": { "description": "[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).", "type": "string" }, "regionInfos": { "description": "[Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.", "type": "array", "items": { "$ref": "InterconnectLocationRegionInfo" } }, "continent": { "description": "[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA ", "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "" ], "enum": [ "AFRICA", "ASIA_PAC", "C_AFRICA", "C_ASIA_PAC", "C_EUROPE", "C_NORTH_AMERICA", "C_SOUTH_AMERICA", "EUROPE", "NORTH_AMERICA", "SOUTH_AMERICA" ] }, "city": { "description": "[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: \"Chicago, IL\", \"Amsterdam, Netherlands\".", "type": "string" }, "availabilityZone": { "description": "[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: \"zone1\" or \"zone2\".", "type": "string" }, "status": { "description": "[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. ", "type": "string", "enumDescriptions": [ "The InterconnectLocation is available for provisioning new Interconnects.", "The InterconnectLocation is closed for provisioning new Interconnects." ], "enum": [ "AVAILABLE", "CLOSED" ] }, "supportsPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "availableFeatures": { "description": "[Output only] List of features available at this InterconnectLocation, which can take one of the following values: - IF_MACSEC ", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Media Access Control security (MACsec)" ], "enum": [ "IF_MACSEC" ] } }, "availableLinkTypes": { "description": "[Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR ", "type": "array", "items": { "type": "string", "enumDescriptions": [ "100G Ethernet, LR Optics.", "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" ], "enum": [ "LINK_TYPE_ETHERNET_100G_LR", "LINK_TYPE_ETHERNET_10G_LR" ] } } } }, "InterconnectLocationRegionInfo": { "id": "InterconnectLocationRegionInfo", "description": "Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.", "type": "object", "properties": { "region": { "description": "URL for the region of this location.", "type": "string" }, "expectedRttMs": { "description": "Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.", "type": "string", "format": "int64" }, "locationPresence": { "description": "Identifies the network presence of this location.", "type": "string", "enumDescriptions": [ "This region is not in any common network presence with this InterconnectLocation.", "This region shares the same regional network presence as this InterconnectLocation.", "[Deprecated] This region is not in any common network presence with this InterconnectLocation.", "[Deprecated] This region shares the same regional network presence as this InterconnectLocation." ], "enum": [ "GLOBAL", "LOCAL_REGION", "LP_GLOBAL", "LP_LOCAL_REGION" ] } } }, "InterconnectRemoteLocationList": { "id": "InterconnectRemoteLocationList", "description": "Response to the list request, and contains a list of interconnect remote locations.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#interconnectRemoteLocationList for lists of interconnect remote locations.", "default": "compute#interconnectRemoteLocationList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of InterconnectRemoteLocation resources.", "type": "array", "items": { "$ref": "InterconnectRemoteLocation" } }, "nextPageToken": { "description": "[Output Only] This token lets you get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "InterconnectRemoteLocation": { "id": "InterconnectRemoteLocation", "description": "Represents a Cross-Cloud Interconnect Remote Location resource. You can use this resource to find remote location details about an Interconnect attachment (VLAN).", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#interconnectRemoteLocation for interconnect remote locations.", "default": "compute#interconnectRemoteLocation", "type": "string" }, "description": { "description": "[Output Only] An optional description of the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "[Output Only] Name of the resource.", "type": "string" }, "peeringdbFacilityId": { "description": "[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).", "type": "string" }, "address": { "description": "[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.", "type": "string" }, "facilityProvider": { "description": "[Output Only] The name of the provider for this facility (e.g., EQUINIX).", "type": "string" }, "facilityProviderFacilityId": { "description": "[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).", "type": "string" }, "continent": { "description": "[Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA ", "type": "string", "enumDescriptions": [ "", "", "", "", "" ], "enum": [ "AFRICA", "ASIA_PAC", "EUROPE", "NORTH_AMERICA", "SOUTH_AMERICA" ] }, "city": { "description": "[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: \"Chicago, IL\", \"Amsterdam, Netherlands\".", "type": "string" }, "status": { "description": "[Output Only] The status of this InterconnectRemoteLocation, which can take one of the following values: - CLOSED: The InterconnectRemoteLocation is closed and is unavailable for provisioning new Cross-Cloud Interconnects. - AVAILABLE: The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects. ", "type": "string", "enumDescriptions": [ "The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects.", "The InterconnectRemoteLocation is closed for provisioning new Cross-Cloud Interconnects." ], "enum": [ "AVAILABLE", "CLOSED" ] }, "remoteService": { "description": "[Output Only] Indicates the service provider present at the remote location. Example values: \"Amazon Web Services\", \"Microsoft Azure\".", "type": "string" }, "permittedConnections": { "description": "[Output Only] Permitted connections.", "type": "array", "items": { "$ref": "InterconnectRemoteLocationPermittedConnections" } }, "constraints": { "description": "[Output Only] Constraints on the parameters for creating Cross-Cloud Interconnect and associated InterconnectAttachments.", "$ref": "InterconnectRemoteLocationConstraints" }, "attachmentConfigurationConstraints": { "description": "[Output Only] Subset of fields from InterconnectAttachment's \|configurationConstraints\| field that apply to all attachments for this remote location.", "$ref": "InterconnectAttachmentConfigurationConstraints" }, "lacp": { "description": "[Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED", "type": "string", "enumDescriptions": [ "LACP_SUPPORTED: LACP is supported, and enabled by default on the Cross-Cloud Interconnect.", "LACP_UNSUPPORTED: LACP is not supported and is not be enabled on this port. GetDiagnostics shows bundleAggregationType as \"static\". GCP does not support LAGs without LACP, so requestedLinkCount must be 1." ], "enum": [ "LACP_SUPPORTED", "LACP_UNSUPPORTED" ] }, "maxLagSize100Gbps": { "description": "[Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps.", "type": "integer", "format": "int32" }, "maxLagSize10Gbps": { "description": "[Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps.", "type": "integer", "format": "int32" } } }, "InterconnectRemoteLocationPermittedConnections": { "id": "InterconnectRemoteLocationPermittedConnections", "type": "object", "properties": { "interconnectLocation": { "description": "[Output Only] URL of an Interconnect location that is permitted to connect to this Interconnect remote location.", "type": "string" } } }, "InterconnectRemoteLocationConstraints": { "id": "InterconnectRemoteLocationConstraints", "type": "object", "properties": { "subnetLengthRange": { "description": "[Output Only] [min-length, max-length] The minimum and maximum value (inclusive) for the IPv4 subnet length. For example, an interconnectRemoteLocation for Azure has {min: 30, max: 30} because Azure requires \/30 subnets. This range specifies the values supported by both cloud providers. Interconnect currently supports \/29 and \/30 IPv4 subnet lengths. If a remote cloud has no constraint on IPv4 subnet length, the range would thus be {min: 29, max: 30}. ", "$ref": "InterconnectRemoteLocationConstraintsSubnetLengthRange" }, "portPairVlan": { "description": "[Output Only] Port pair VLAN constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_VLAN, PORT_PAIR_MATCHING_VLAN", "type": "string", "enumDescriptions": [ "If PORT_PAIR_MATCHING_VLAN, the Interconnect for this attachment is part of a pair of ports that should have matching VLAN allocations. This occurs with Cross-Cloud Interconnect to Azure remote locations. While GCP's API does not explicitly group pairs of ports, the UI uses this field to ensure matching VLAN ids when configuring a redundant VLAN pair.", "PORT_PAIR_UNCONSTRAINED_VLAN means there is no constraint." ], "enum": [ "PORT_PAIR_MATCHING_VLAN", "PORT_PAIR_UNCONSTRAINED_VLAN" ] }, "portPairRemoteLocation": { "description": "[Output Only] Port pair remote location constraints, which can take one of the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, PORT_PAIR_MATCHING_REMOTE_LOCATION. Google Cloud API refers only to individual ports, but the UI uses this field when ordering a pair of ports, to prevent users from accidentally ordering something that is incompatible with their cloud provider. Specifically, when ordering a redundant pair of Cross-Cloud Interconnect ports, and one of them uses a remote location with portPairMatchingRemoteLocation set to matching, the UI requires that both ports use the same remote location.", "type": "string", "enumDescriptions": [ "If PORT_PAIR_MATCHING_REMOTE_LOCATION, the remote cloud provider allocates ports in pairs, and the user should choose the same remote location for both ports.", "If PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, a user may opt to provision a redundant pair of Cross-Cloud Interconnects using two different remote locations in the same city." ], "enum": [ "PORT_PAIR_MATCHING_REMOTE_LOCATION", "PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION" ] } } }, "InterconnectRemoteLocationConstraintsSubnetLengthRange": { "id": "InterconnectRemoteLocationConstraintsSubnetLengthRange", "type": "object", "properties": { "min": { "type": "integer", "format": "int32" }, "max": { "type": "integer", "format": "int32" } } }, "LicenseCode": { "id": "LicenseCode", "description": "Represents a License Code resource. A License Code is a unique identifier used to represent a license resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#licenseCode for licenses.", "default": "compute#licenseCode", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "name": { "description": "[Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer.", "pattern": "[0-9]{0,20}?", "annotations": { "required": [ "compute.licenses.insert" ] }, "type": "string" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "description": { "description": "[Output Only] Description of this License Code.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "transferable": { "description": "[Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred.", "type": "boolean" }, "state": { "description": "[Output Only] Current state of this License Code.", "type": "string", "enumDescriptions": [ "Machines are not allowed to attach boot disks with this License Code. Requests 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." ], "enum": [ "DISABLED", "ENABLED", "RESTRICTED", "STATE_UNSPECIFIED", "TERMINATED" ] }, "licenseAlias": { "description": "[Output Only] URL and description aliases of Licenses with the same License Code.", "type": "array", "items": { "$ref": "LicenseCodeLicenseAlias" } } } }, "LicenseCodeLicenseAlias": { "id": "LicenseCodeLicenseAlias", "type": "object", "properties": { "selfLink": { "description": "[Output Only] URL of license corresponding to this License Code.", "type": "string" }, "description": { "description": "[Output Only] Description of this License Code.", "type": "string" } } }, "License": { "id": "License", "description": "Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#license for licenses.", "default": "compute#license", "type": "string" }, "name": { "description": "Name of the resource. The name must be 1-63 characters long and comply with RFC1035.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.images.insert" ] }, "type": "string" }, "chargesUseFee": { "description": "[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.", "type": "boolean" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "licenseCode": { "description": "[Output Only] The unique code used to attach this license to images, snapshots, and disks.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "description": { "description": "An optional textual description of the resource; provided by the client when the resource is created.", "type": "string" }, "transferable": { "description": "If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk.", "type": "boolean" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "resourceRequirements": { "description": "[Input Only] Deprecated.", "$ref": "LicenseResourceRequirements" } } }, "LicenseResourceRequirements": { "id": "LicenseResourceRequirements", "type": "object", "properties": { "minGuestCpuCount": { "description": "[Input Only] Deprecated. This field no longer reflects the minimum number of guest cpus required to use the Instance.", "type": "integer", "format": "int32" }, "minMemoryMb": { "description": "[Input Only] Deprecated. This field no longer reflects the minimum memory required to use the Instance.", "type": "integer", "format": "int32" } } }, "LicensesListResponse": { "id": "LicensesListResponse", "type": "object", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of License resources.", "type": "array", "items": { "$ref": "License" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "MachineImageList": { "id": "MachineImageList", "description": "A list of machine images.", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#machineImagesListResponse for machine image lists.", "default": "compute#machineImageList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of MachineImage resources.", "type": "array", "items": { "$ref": "MachineImage" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "MachineImage": { "id": "MachineImage", "description": "Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images.", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#machineImage for machine image.", "default": "compute#machineImage", "type": "string" }, "id": { "description": "[Output Only] A unique identifier for this machine image. The server defines this identifier.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] The creation timestamp for this machine image in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.machineImages.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] The URL for this machine image. The server defines this URL.", "type": "string" }, "sourceInstance": { "description": "The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/instances\/instance - projects\/project\/zones\/zone\/instances\/instance ", "type": "string" }, "status": { "description": "[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.", "type": "string", "enumDescriptions": [ "", "", "", "", "" ], "enum": [ "CREATING", "DELETING", "INVALID", "READY", "UPLOADING" ] }, "sourceInstanceProperties": { "description": "[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field.", "$ref": "SourceInstanceProperties" }, "instanceProperties": { "description": "[Output Only] Properties of source instance", "$ref": "InstanceProperties" }, "savedDisks": { "description": "An array of Machine Image specific properties for disks attached to the source instance", "type": "array", "items": { "$ref": "SavedDisk" } }, "storageLocations": { "description": "The regional or multi-regional Cloud Storage bucket location where the machine image is stored.", "type": "array", "items": { "type": "string" } }, "machineImageEncryptionKey": { "description": "Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later.", "$ref": "CustomerEncryptionKey" }, "guestFlush": { "description": "[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.", "type": "boolean" }, "sourceDiskEncryptionKeys": { "description": "[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.", "type": "array", "items": { "$ref": "SourceDiskEncryptionKey" } }, "totalStorageBytes": { "description": "[Output Only] Total size of the storage used by the machine image.", "type": "string", "format": "int64" }, "satisfiesPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" } } }, "SourceInstanceProperties": { "id": "SourceInstanceProperties", "description": "DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field.", "type": "object", "properties": { "description": { "description": "An optional text description for the instances that are created from this machine image.", "type": "string" }, "tags": { "description": "A list of tags to apply to the instances that are created from this machine image. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.", "$ref": "Tags" }, "machineType": { "description": "The machine type to use for instances that are created from this machine image.", "type": "string" }, "canIpForward": { "description": "Enables instances created based on this machine image to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.", "type": "boolean" }, "networkInterfaces": { "description": "An array of network access configurations for this interface.", "type": "array", "items": { "$ref": "NetworkInterface" } }, "disks": { "description": "An array of disks that are associated with the instances that are created from this machine image.", "type": "array", "items": { "$ref": "SavedAttachedDisk" } }, "metadata": { "description": "The metadata key\/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.", "$ref": "Metadata" }, "serviceAccounts": { "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances.", "type": "array", "items": { "$ref": "ServiceAccount" } }, "scheduling": { "description": "Specifies the scheduling options for the instances that are created from this machine image.", "$ref": "Scheduling" }, "labels": { "description": "Labels to apply to instances that are created from this machine image.", "type": "object", "additionalProperties": { "type": "string" } }, "guestAccelerators": { "description": "A list of guest accelerator cards' type and count to use for instances created from this machine image.", "type": "array", "items": { "$ref": "AcceleratorConfig" } }, "minCpuPlatform": { "description": "Minimum cpu\/platform to be used by instances created from this machine image. The instance may be scheduled on the specified or newer cpu\/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\". For more information, read Specifying a Minimum CPU Platform.", "type": "string" }, "deletionProtection": { "description": "Whether the instance created from this machine image should be protected against deletion.", "type": "boolean" }, "keyRevocationActionType": { "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", "type": "string", "enumDescriptions": [ "Default value. This value is unused.", "Indicates user chose no operation.", "Indicates user chose to opt for VM shutdown on key revocation." ], "enum": [ "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", "NONE", "STOP" ] } } }, "SavedAttachedDisk": { "id": "SavedAttachedDisk", "description": "DEPRECATED: Please use compute#savedDisk instead. An instance-attached disk resource.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.", "default": "compute#savedAttachedDisk", "type": "string" }, "type": { "description": "Specifies the type of the attached disk, either SCRATCH or PERSISTENT.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "PERSISTENT", "SCRATCH" ] }, "mode": { "description": "The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY.", "type": "string", "enumDescriptions": [ "Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.", "[Default]* Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode." ], "enum": [ "READ_ONLY", "READ_WRITE" ] }, "source": { "description": "Specifies a URL of the disk attached to the source instance.", "type": "string" }, "deviceName": { "description": "Specifies the name of the disk attached to the source instance.", "type": "string" }, "index": { "description": "Specifies zero-based index of the disk that is attached to the source instance.", "type": "integer", "format": "int32" }, "boot": { "description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.", "type": "boolean" }, "autoDelete": { "description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).", "type": "boolean" }, "licenses": { "description": "[Output Only] Any valid publicly visible licenses.", "type": "array", "items": { "type": "string" } }, "interface": { "description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NVME", "SCSI" ] }, "guestOsFeatures": { "description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.", "type": "array", "items": { "$ref": "GuestOsFeature" } }, "diskEncryptionKey": { "description": "The encryption key for the disk.", "$ref": "CustomerEncryptionKey" }, "diskSizeGb": { "description": "The size of the disk in base-2 GB.", "type": "string", "format": "int64" }, "storageBytes": { "description": "[Output Only] A size of the storage used by the disk's snapshot by this machine image.", "type": "string", "format": "int64" }, "storageBytesStatus": { "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "UPDATING", "UP_TO_DATE" ] }, "diskType": { "description": "[Output Only] URL of the disk type resource. For example: projects\/project \/zones\/zone\/diskTypes\/pd-standard or pd-ssd", "type": "string" } } }, "SavedDisk": { "id": "SavedDisk", "description": "An instance-attached disk resource.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#savedDisk for attached disks.", "default": "compute#savedDisk", "type": "string" }, "sourceDisk": { "description": "Specifies a URL of the disk attached to the source instance.", "type": "string" }, "storageBytes": { "description": "[Output Only] Size of the individual disk snapshot used by this machine image.", "type": "string", "format": "int64" }, "storageBytesStatus": { "description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "UPDATING", "UP_TO_DATE" ] }, "architecture": { "description": "[Output Only] The architecture of the attached disk.", "type": "string", "enumDescriptions": [ "Default value indicating Architecture is not set.", "Machines with architecture ARM64", "Machines with architecture X86_64" ], "enum": [ "ARCHITECTURE_UNSPECIFIED", "ARM64", "X86_64" ] } } }, "SourceDiskEncryptionKey": { "id": "SourceDiskEncryptionKey", "type": "object", "properties": { "sourceDisk": { "description": "URL of the disk attached to the source instance. This can be a full or valid partial URL. For example, the following are valid values: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/disks\/disk - projects\/project\/zones\/zone\/disks\/disk - zones\/zone\/disks\/disk ", "type": "string" }, "diskEncryptionKey": { "description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.", "$ref": "CustomerEncryptionKey" } } }, "MachineTypeList": { "id": "MachineTypeList", "description": "Contains a list of machine types.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.", "default": "compute#machineTypeList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of MachineType resources.", "type": "array", "items": { "$ref": "MachineType" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "MachineType": { "id": "MachineType", "description": "Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types.", "type": "object", "properties": { "kind": { "description": "[Output Only] The type of the resource. Always compute#machineType for machine types.", "default": "compute#machineType", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "[Output Only] Name of the resource.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "[Output Only] An optional textual description of the resource.", "type": "string" }, "guestCpus": { "description": "[Output Only] The number of virtual CPUs that are available to the instance.", "type": "integer", "format": "int32" }, "memoryMb": { "description": "[Output Only] The amount of physical memory available to the instance, defined in MB.", "type": "integer", "format": "int32" }, "imageSpaceGb": { "description": "[Deprecated] This property is deprecated and will never be populated with any relevant values.", "type": "integer", "format": "int32" }, "scratchDisks": { "description": "[Output Only] A list of extended scratch disks assigned to the instance.", "type": "array", "items": { "type": "object", "properties": { "diskGb": { "description": "Size of the scratch disk, defined in GB.", "type": "integer", "format": "int32" } } } }, "maximumPersistentDisks": { "description": "[Output Only] Maximum persistent disks allowed.", "type": "integer", "format": "int32" }, "maximumPersistentDisksSizeGb": { "description": "[Output Only] Maximum total persistent disks size (GB) allowed.", "type": "string", "format": "int64" }, "deprecated": { "description": "[Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable.", "$ref": "DeprecationStatus" }, "zone": { "description": "[Output Only] The name of the zone where the machine type resides, such as us-central1-a.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "isSharedCpu": { "description": "[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.", "type": "boolean" }, "accelerators": { "description": "[Output Only] A list of accelerator configurations assigned to this machine type.", "type": "array", "items": { "type": "object", "properties": { "guestAcceleratorType": { "description": "The accelerator type resource name, not a full URL, e.g. nvidia-tesla-t4.", "type": "string" }, "guestAcceleratorCount": { "description": "Number of accelerator cards exposed to the guest.", "type": "integer", "format": "int32" } } } }, "architecture": { "description": "[Output Only] The architecture of the machine type.", "type": "string", "enumDescriptions": [ "Default value indicating Architecture is not set.", "Machines with architecture ARM64", "Machines with architecture X86_64" ], "enum": [ "ARCHITECTURE_UNSPECIFIED", "ARM64", "X86_64" ] } } }, "MachineTypeAggregatedList": { "id": "MachineTypeAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.", "default": "compute#machineTypeAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of MachineTypesScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of machine types.", "$ref": "MachineTypesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "MachineTypesScopedList": { "id": "MachineTypesScopedList", "type": "object", "properties": { "machineTypes": { "description": "[Output Only] A list of machine types contained in this scope.", "type": "array", "items": { "$ref": "MachineType" } }, "warning": { "description": "[Output Only] An informational warning that appears when the machine types list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NetworkAttachmentAggregatedList": { "id": "NetworkAttachmentAggregatedList", "description": "Contains a list of NetworkAttachmentsScopedList.", "type": "object", "properties": { "kind": { "default": "compute#networkAttachmentAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of NetworkAttachmentsScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of NetworkAttachments.", "$ref": "NetworkAttachmentsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NetworkAttachmentsScopedList": { "id": "NetworkAttachmentsScopedList", "type": "object", "properties": { "networkAttachments": { "description": "A list of NetworkAttachments contained in this scope.", "type": "array", "items": { "$ref": "NetworkAttachment" } }, "warning": { "description": "Informational warning which replaces the list of network attachments when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NetworkAttachment": { "id": "NetworkAttachment", "description": "NetworkAttachments A network attachment resource ...", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource.", "default": "compute#networkAttachment", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.networkAttachments.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource's resource id.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "connectionPreference": { "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "ACCEPT_AUTOMATIC", "ACCEPT_MANUAL", "INVALID" ] }, "connectionEndpoints": { "description": "[Output Only] An array of connections for all the producers connected to this network attachment.", "type": "array", "items": { "$ref": "NetworkAttachmentConnectedEndpoint" } }, "subnetworks": { "description": "An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment.", "type": "array", "items": { "type": "string" } }, "producerRejectLists": { "description": "Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number.", "type": "array", "items": { "type": "string" } }, "producerAcceptLists": { "description": "Projects that are allowed to connect to this network attachment. The project can be specified using its id or number.", "type": "array", "items": { "type": "string" } }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch.", "type": "string", "format": "byte" }, "network": { "description": "[Output Only] The URL of the network which the Network Attachment belongs to. Practically it is inferred by fetching the network of the first subnetwork associated. Because it is required that all the subnetworks must be from the same network, it is assured that the Network Attachment belongs to the same network as all the subnetworks.", "type": "string" } } }, "NetworkAttachmentConnectedEndpoint": { "id": "NetworkAttachmentConnectedEndpoint", "description": "[Output Only] A connection connected to this network attachment.", "type": "object", "properties": { "status": { "description": "The status of a connected endpoint to this network attachment.", "type": "string", "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 from the producer to reach its VPC.", "The consumer prohibits traffic from the producer to reach its VPC.", "" ], "enum": [ "ACCEPTED", "CLOSED", "NEEDS_ATTENTION", "PENDING", "REJECTED", "STATUS_UNSPECIFIED" ] }, "projectIdOrNum": { "description": "The project id or number of the interface to which the IP was assigned.", "type": "string" }, "subnetwork": { "description": "The subnetwork used to assign the IP to the producer instance network interface.", "type": "string" }, "ipAddress": { "description": "The IPv4 address assigned to the producer instance network interface. This value will be a range in case of Serverless.", "type": "string" }, "ipv6Address": { "description": "The IPv6 address assigned to the producer instance network interface. This is only assigned when the stack types of both the instance network interface and the consumer subnet are IPv4_IPv6.", "type": "string" }, "secondaryIpCidrRanges": { "description": "Alias IP ranges from the same subnetwork.", "type": "array", "items": { "type": "string" } }, "subnetworkCidrRange": { "description": "[Output Only] The CIDR range of the subnet from which the IPv4 internal IP was allocated from.", "type": "string" } } }, "NetworkAttachmentList": { "id": "NetworkAttachmentList", "type": "object", "properties": { "kind": { "default": "compute#networkAttachmentList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of NetworkAttachment resources.", "type": "array", "items": { "$ref": "NetworkAttachment" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NetworkEdgeSecurityService": { "id": "NetworkEdgeSecurityService", "description": "Represents a Google Cloud Armor network edge security service resource.", "type": "object", "properties": { "kind": { "description": "[Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices", "default": "compute#networkEdgeSecurityService", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService.", "type": "string", "format": "byte" }, "securityPolicy": { "description": "The resource URL for the network edge security service associated with this network edge security service.", "type": "string" } } }, "NetworkEdgeSecurityServiceAggregatedList": { "id": "NetworkEdgeSecurityServiceAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#networkEdgeSecurityServiceAggregatedList for lists of Network Edge Security Services.", "default": "compute#networkEdgeSecurityServiceAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of NetworkEdgeSecurityServicesScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of security policies.", "$ref": "NetworkEdgeSecurityServicesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "etag": { "type": "string" }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "NetworkEdgeSecurityServicesScopedList": { "id": "NetworkEdgeSecurityServicesScopedList", "type": "object", "properties": { "networkEdgeSecurityServices": { "description": "A list of NetworkEdgeSecurityServices contained in this scope.", "type": "array", "items": { "$ref": "NetworkEdgeSecurityService" } }, "warning": { "description": "Informational warning which replaces the list of security policies when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NetworkEndpointGroupList": { "id": "NetworkEndpointGroupList", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.", "default": "compute#networkEndpointGroupList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of NetworkEndpointGroup resources.", "type": "array", "items": { "$ref": "NetworkEndpointGroup" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NetworkEndpointGroup": { "id": "NetworkEndpointGroup", "description": "Represents a collection of network endpoints. A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs for different use cases, see Network endpoint groups overview.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.", "default": "compute#networkEndpointGroup", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "name": { "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "networkEndpointType": { "description": "Type of network endpoints in this network endpoint group. Can be one of GCE_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.", "type": "string", "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 Port.", "The network endpoint is represented by fully qualified domain name and port.", "The network endpoint is represented by an internet IP address and port.", "The network endpoint is represented by an IP address and port. The endpoint belongs to a VM or pod running in a customer's on-premises.", "The network endpoint is either public Google APIs or services exposed by other GCP Project with a Service Attachment. The connection is set up by private service connect", "The network endpoint is handled by specified serverless infrastructure." ], "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" ] }, "size": { "description": "[Output only] Number of network endpoints in the network endpoint group.", "type": "integer", "format": "int32" }, "region": { "description": "[Output Only] The URL of the region where the network endpoint group is located.", "type": "string" }, "zone": { "description": "[Output Only] The URL of the zone where the network endpoint group is located.", "type": "string" }, "network": { "description": "The URL of the network to which all network endpoints in the NEG belong. Uses default project network if unspecified.", "type": "string" }, "subnetwork": { "description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong.", "type": "string" }, "defaultPort": { "description": "The default port used if the port number is not specified in the network endpoint. Optional. If the network endpoint type is either GCE_VM_IP, SERVERLESS or PRIVATE_SERVICE_CONNECT, this field must not be specified.", "type": "integer", "format": "int32" }, "annotations": { "description": "Optional. Metadata defined as annotations on the network endpoint group.", "type": "object", "additionalProperties": { "type": "string" } }, "cloudRun": { "description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.", "$ref": "NetworkEndpointGroupCloudRun" }, "appEngine": { "description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.", "$ref": "NetworkEndpointGroupAppEngine" }, "cloudFunction": { "description": "Optional. Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set.", "$ref": "NetworkEndpointGroupCloudFunction" }, "pscTargetService": { "description": "The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: asia-northeast3-cloudkms.googleapis.com. Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.", "type": "string" }, "pscData": { "description": "Optional. Only valid when networkEndpointType is PRIVATE_SERVICE_CONNECT.", "$ref": "NetworkEndpointGroupPscData" } } }, "NetworkEndpointGroupCloudRun": { "id": "NetworkEndpointGroupCloudRun", "description": "Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.", "type": "object", "properties": { "service": { "description": "Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: \"run-service\".", "type": "string" }, "tag": { "description": "Optional Cloud Run tag represents the \"named-revision\" to provide additional fine-grained traffic routing information. The tag must be 1-63 characters long, and comply with RFC1035. Example value: \"revision-0010\".", "type": "string" }, "urlMask": { "description": "An URL mask is one of the main components of the Cloud Function. A template to parse <service> and <tag> fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services. For example, request URLs foo1.domain.com\/bar1 and foo1.domain.com\/bar2 can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask <tag>.domain.com\/<service>. The URL mask will parse them to { service=\"bar1\", tag=\"foo1\" } and { service=\"bar2\", tag=\"foo2\" } respectively.", "type": "string" } } }, "NetworkEndpointGroupAppEngine": { "id": "NetworkEndpointGroupAppEngine", "description": "Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.", "type": "object", "properties": { "service": { "description": "Optional serving service. The service name is case-sensitive and must be 1-63 characters long. Example value: default, my-service.", "type": "string" }, "version": { "description": "Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2.", "type": "string" }, "urlMask": { "description": "An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com\/v1 and foo1-dot-appname.appspot.com\/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com\/<version>. The URL mask will parse them to { service = \"foo1\", version = \"v1\" } and { service = \"foo1\", version = \"v2\" } respectively.", "type": "string" } } }, "NetworkEndpointGroupCloudFunction": { "id": "NetworkEndpointGroupCloudFunction", "description": "Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.", "type": "object", "properties": { "function": { "description": "A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1.", "type": "string" }, "urlMask": { "description": "An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com\/function1 and mydomain.com\/function2 can be backed by the same Serverless NEG with URL mask \/<function>. The URL mask will parse them to { function = \"function1\" } and { function = \"function2\" } respectively.", "type": "string" } } }, "NetworkEndpointGroupPscData": { "id": "NetworkEndpointGroupPscData", "description": "All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT.", "type": "object", "properties": { "consumerPscAddress": { "description": "[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.", "type": "string" }, "pscConnectionId": { "description": "[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.", "type": "string", "format": "uint64" }, "pscConnectionStatus": { "description": "[Output Only] The connection status of the PSC Forwarding Rule.", "type": "string", "enumDescriptions": [ "The connection has been accepted by the producer.", "The connection has been closed by the producer and will not serve traffic going forward.", "The connection has been accepted by the producer, but the producer needs to 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.", "" ], "enum": [ "ACCEPTED", "CLOSED", "NEEDS_ATTENTION", "PENDING", "REJECTED", "STATUS_UNSPECIFIED" ] }, "producerPort": { "description": "The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type", "type": "integer", "format": "int32" } } }, "NetworkEndpointGroupAggregatedList": { "id": "NetworkEndpointGroupAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.", "default": "compute#networkEndpointGroupAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of NetworkEndpointGroupsScopedList resources.", "type": "object", "additionalProperties": { "description": "The name of the scope that contains this set of network endpoint groups.", "$ref": "NetworkEndpointGroupsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "NetworkEndpointGroupsScopedList": { "id": "NetworkEndpointGroupsScopedList", "type": "object", "properties": { "networkEndpointGroups": { "description": "[Output Only] The list of network endpoint groups that are contained in this scope.", "type": "array", "items": { "$ref": "NetworkEndpointGroup" } }, "warning": { "description": "[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NetworkEndpointGroupsAttachEndpointsRequest": { "id": "NetworkEndpointGroupsAttachEndpointsRequest", "type": "object", "properties": { "networkEndpoints": { "description": "The list of network endpoints to be attached.", "type": "array", "items": { "$ref": "NetworkEndpoint" } } } }, "NetworkEndpoint": { "id": "NetworkEndpoint", "description": "The network endpoint.", "type": "object", "properties": { "ipAddress": { "description": "Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork.", "type": "string" }, "ipv6Address": { "description": "Optional IPv6 address of network endpoint.", "type": "string" }, "fqdn": { "description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.", "type": "string" }, "port": { "description": "Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used. This field can not be set for network endpoints of type GCE_VM_IP.", "type": "integer", "format": "int32" }, "clientDestinationPort": { "description": "Represents the port number to which PSC consumer sends packets. Optional. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.", "type": "integer", "format": "int32" }, "instance": { "description": "The name or a URL of VM instance of this network endpoint. Optional, the field presence depends on the network endpoint type. The field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance.", "type": "string" }, "annotations": { "description": "Optional metadata defined as annotations on the network endpoint.", "type": "object", "additionalProperties": { "type": "string" } } } }, "NetworkEndpointGroupsDetachEndpointsRequest": { "id": "NetworkEndpointGroupsDetachEndpointsRequest", "type": "object", "properties": { "networkEndpoints": { "description": "The list of network endpoints to be detached.", "type": "array", "items": { "$ref": "NetworkEndpoint" } } } }, "NetworkEndpointGroupsListEndpointsRequest": { "id": "NetworkEndpointGroupsListEndpointsRequest", "type": "object", "properties": { "healthStatus": { "description": "Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.", "type": "string", "enumDescriptions": [ "Show the health status for each network endpoint. Impacts latency of the call.", "Health status for network endpoints will not be provided." ], "enum": [ "SHOW", "SKIP" ] } } }, "NetworkEndpointGroupsListNetworkEndpoints": { "id": "NetworkEndpointGroupsListNetworkEndpoints", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.", "default": "compute#networkEndpointGroupsListNetworkEndpoints", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of NetworkEndpointWithHealthStatus resources.", "type": "array", "items": { "$ref": "NetworkEndpointWithHealthStatus" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NetworkEndpointWithHealthStatus": { "id": "NetworkEndpointWithHealthStatus", "type": "object", "properties": { "networkEndpoint": { "description": "[Output only] The network endpoint.", "$ref": "NetworkEndpoint" }, "healths": { "description": "[Output only] The health status of network endpoint. Optional. Displayed only if the network endpoint has centralized health checking configured.", "type": "array", "items": { "$ref": "HealthStatusForNetworkEndpoint" } } } }, "HealthStatusForNetworkEndpoint": { "id": "HealthStatusForNetworkEndpoint", "type": "object", "properties": { "forwardingRule": { "description": "URL of the forwarding rule associated with the health state of the network endpoint.", "$ref": "ForwardingRuleReference" }, "backendService": { "description": "URL of the backend service associated with the health state of the network endpoint.", "$ref": "BackendServiceReference" }, "healthCheck": { "description": "URL of the health check associated with the health state of the network endpoint.", "$ref": "HealthCheckReference" }, "healthCheckService": { "description": "URL of the health check service associated with the health state of the network endpoint.", "$ref": "HealthCheckServiceReference" }, "healthState": { "description": "Health state of the network endpoint determined based on the health checks configured.", "type": "string", "enumDescriptions": [ "Endpoint is being drained.", "Endpoint is healthy.", "Endpoint is unhealthy.", "Health status of the endpoint is unknown." ], "enum": [ "DRAINING", "HEALTHY", "UNHEALTHY", "UNKNOWN" ] }, "ipv6HealthState": { "description": "Health state of the ipv6 network endpoint determined based on the health checks configured.", "type": "string", "enumDescriptions": [ "Endpoint is being drained.", "Endpoint is healthy.", "Endpoint is unhealthy.", "Health status of the endpoint is unknown." ], "enum": [ "DRAINING", "HEALTHY", "UNHEALTHY", "UNKNOWN" ] } } }, "ForwardingRuleReference": { "id": "ForwardingRuleReference", "type": "object", "properties": { "forwardingRule": { "type": "string" } } }, "BackendServiceReference": { "id": "BackendServiceReference", "type": "object", "properties": { "backendService": { "type": "string" } } }, "HealthCheckReference": { "id": "HealthCheckReference", "description": "A full or valid partial URL to a health check. For example, the following are valid URLs: - https:\/\/www.googleapis.com\/compute\/beta\/projects\/project-id\/global\/httpHealthChecks\/health-check - projects\/project-id\/global\/httpHealthChecks\/health-check - global\/httpHealthChecks\/health-check ", "type": "object", "properties": { "healthCheck": { "type": "string" } } }, "HealthCheckServiceReference": { "id": "HealthCheckServiceReference", "description": "A full or valid partial URL to a health check service. For example, the following are valid URLs: - https:\/\/www.googleapis.com\/compute\/beta\/projects\/project-id\/regions\/us-west1\/healthCheckServices\/health-check-service - projects\/project-id\/regions\/us-west1\/healthCheckServices\/health-check-service - regions\/us-west1\/healthCheckServices\/health-check-service ", "type": "object", "properties": { "healthCheckService": { "type": "string" } } }, "GlobalNetworkEndpointGroupsAttachEndpointsRequest": { "id": "GlobalNetworkEndpointGroupsAttachEndpointsRequest", "type": "object", "properties": { "networkEndpoints": { "description": "The list of network endpoints to be attached.", "type": "array", "items": { "$ref": "NetworkEndpoint" } } } }, "GlobalNetworkEndpointGroupsDetachEndpointsRequest": { "id": "GlobalNetworkEndpointGroupsDetachEndpointsRequest", "type": "object", "properties": { "networkEndpoints": { "description": "The list of network endpoints to be detached.", "type": "array", "items": { "$ref": "NetworkEndpoint" } } } }, "RegionNetworkEndpointGroupsAttachEndpointsRequest": { "id": "RegionNetworkEndpointGroupsAttachEndpointsRequest", "type": "object", "properties": { "networkEndpoints": { "description": "The list of network endpoints to be attached.", "type": "array", "items": { "$ref": "NetworkEndpoint" } } } }, "RegionNetworkEndpointGroupsDetachEndpointsRequest": { "id": "RegionNetworkEndpointGroupsDetachEndpointsRequest", "type": "object", "properties": { "networkEndpoints": { "description": "The list of network endpoints to be detached.", "type": "array", "items": { "$ref": "NetworkEndpoint" } } } }, "NetworkList": { "id": "NetworkList", "description": "Contains a list of networks.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#networkList for lists of networks.", "default": "compute#networkList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Network resources.", "type": "array", "items": { "$ref": "Network" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Network": { "id": "Network", "description": "Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#network for networks.", "default": "compute#network", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.networks.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this field when you create the resource.", "type": "string" }, "IPv4Range": { "description": "Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0\/16. Provided by the client when the network is created.", "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}\/[0-9]{1,2}", "deprecated": true, "type": "string" }, "gatewayIPv4": { "description": "[Output Only] The gateway address for default routing out of the network, selected by Google Cloud.", "pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" }, "autoCreateSubnetworks": { "description": "Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method.", "type": "boolean" }, "subnetworks": { "description": "[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.", "type": "array", "items": { "type": "string" } }, "peerings": { "description": "[Output Only] A list of network peerings for the resource.", "type": "array", "items": { "$ref": "NetworkPeering" } }, "routingConfig": { "description": "The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.", "$ref": "NetworkRoutingConfig" }, "mtu": { "description": "Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.", "type": "integer", "format": "int32" }, "firewallPolicy": { "description": "[Output Only] URL of the firewall policy the network is associated with.", "type": "string" }, "networkFirewallPolicyEnforcementOrder": { "description": "The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "AFTER_CLASSIC_FIREWALL", "BEFORE_CLASSIC_FIREWALL" ] }, "enableUlaInternalIpv6": { "description": "Enable ULA internal ipv6 on this network. Enabling this feature will assign a \/48 from google defined ULA prefix fd20::\/20. .", "type": "boolean" }, "internalIpv6Range": { "description": "When enabling ula internal ipv6, caller optionally can specify the \/48 range they want from the google defined ULA prefix fd20::\/20. The input must be a valid \/48 ULA IPv6 address and must be within the fd20::\/20. Operation will fail if the speficied \/48 is already in used by another resource. If the field is not speficied, then a \/48 range will be randomly allocated from fd20::\/20 and returned via this field. .", "type": "string" }, "networkProfile": { "description": "A full or partial URL of the network profile to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs: - https:\/\/www.googleapis.com\/compute\/{api_version}\/projects\/{project_id}\/global\/networkProfiles\/{network_profile_name} - projects\/{project_id}\/global\/networkProfiles\/{network_profile_name} ", "type": "string" } } }, "NetworkPeering": { "id": "NetworkPeering", "description": "A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.", "type": "object", "properties": { "name": { "description": "Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9][a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "type": "string" }, "network": { "description": "The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.", "type": "string" }, "state": { "description": "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.", "type": "string", "enumDescriptions": [ "Matching configuration exists on the peer.", "There is no matching configuration on the peer, including the case when peer does not exist." ], "enum": [ "ACTIVE", "INACTIVE" ] }, "stateDetails": { "description": "[Output Only] Details about the current state of the peering.", "type": "string" }, "autoCreateRoutes": { "description": "This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", "type": "boolean" }, "exportCustomRoutes": { "description": "Whether to export the custom routes to peer network. The default value is false.", "type": "boolean" }, "importCustomRoutes": { "description": "Whether to import the custom routes from peer network. The default value is false.", "type": "boolean" }, "exchangeSubnetRoutes": { "description": "Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", "type": "boolean" }, "exportSubnetRoutesWithPublicIp": { "description": "Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. IPv4 special-use ranges are always exported to peers and are not controlled by this field.", "type": "boolean" }, "importSubnetRoutesWithPublicIp": { "description": "Whether subnet routes with public IP range are imported. The default value is false. IPv4 special-use ranges are always imported from peers and are not controlled by this field.", "type": "boolean" }, "peerMtu": { "description": "Maximum Transmission Unit in bytes.", "type": "integer", "format": "int32" }, "stackType": { "description": "Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.", "type": "string", "enumDescriptions": [ "This Peering will allow IPv4 traffic and routes to be exchanged. Additionally if the matching peering is IPV4_IPV6, IPv6 traffic and routes will be exchanged as well.", "This Peering will only allow IPv4 traffic and routes to be exchanged, even if the matching peering is IPV4_IPV6." ], "enum": [ "IPV4_IPV6", "IPV4_ONLY" ] } } }, "NetworkRoutingConfig": { "id": "NetworkRoutingConfig", "description": "A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide.", "type": "object", "properties": { "routingMode": { "description": "The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "GLOBAL", "REGIONAL" ] }, "bgpBestPathSelectionMode": { "description": "The BGP best path selection algorithm to be employed within this network for dynamic routes learned by Cloud Routers. Can be LEGACY (default) or STANDARD.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "LEGACY", "STANDARD" ] }, "bgpAlwaysCompareMed": { "description": "Enable comparison of Multi-Exit Discriminators (MED) across routes with different neighbor ASNs when using the STANDARD BGP best path selection algorithm.", "type": "boolean" }, "bgpInterRegionCost": { "description": "Allows to define a preferred approach for handling inter-region cost in the selection process when using the STANDARD BGP best path selection algorithm. Can be DEFAULT or ADD_COST_TO_MED.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "ADD_COST_TO_MED", "DEFAULT" ] }, "effectiveBgpAlwaysCompareMed": { "description": "[Output Only] Effective value of the bgp_always_compare_med field.", "type": "boolean" }, "effectiveBgpInterRegionCost": { "description": "[Output Only] Effective value of the bgp_inter_region_cost field.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "ADD_COST_TO_MED", "DEFAULT" ] } } }, "NetworksUpdatePeeringRequest": { "id": "NetworksUpdatePeeringRequest", "type": "object", "properties": { "networkPeering": { "$ref": "NetworkPeering" } } }, "NetworksAddPeeringRequest": { "id": "NetworksAddPeeringRequest", "type": "object", "properties": { "name": { "description": "Name of the peering, which should conform to RFC1035.", "annotations": { "required": [ "compute.networks.addPeering" ] }, "type": "string" }, "peerNetwork": { "description": "URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.", "type": "string" }, "autoCreateRoutes": { "description": "This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.", "type": "boolean" }, "networkPeering": { "description": "Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon.", "$ref": "NetworkPeering" } } }, "NetworksRemovePeeringRequest": { "id": "NetworksRemovePeeringRequest", "type": "object", "properties": { "name": { "description": "Name of the peering, which should conform to RFC1035.", "type": "string" } } }, "NetworksGetEffectiveFirewallsResponse": { "id": "NetworksGetEffectiveFirewallsResponse", "type": "object", "properties": { "firewalls": { "description": "Effective firewalls on the network.", "type": "array", "items": { "$ref": "Firewall" } }, "firewallPolicys": { "description": "[Output Only] Effective firewalls from firewall policy. It returns Global Network Firewall Policies and Hierarchical Firewall Policies. Use regionNetworkFirewallPolicies.getEffectiveFirewalls to get Regional Network Firewall Policies as well.", "type": "array", "items": { "$ref": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy" } } } }, "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy": { "id": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy", "type": "object", "properties": { "name": { "description": "[Output Only] The name of the firewall policy.", "type": "string" }, "type": { "description": "[Output Only] The type of the firewall policy.", "type": "string", "enumDescriptions": [ "", "", "", "" ], "enum": [ "HIERARCHY", "NETWORK", "SYSTEM", "UNSPECIFIED" ] }, "shortName": { "description": "[Output Only] The short name of the firewall policy.", "type": "string" }, "displayName": { "description": "[Output Only] Deprecated, please use short name instead. The display name of the firewall policy.", "deprecated": true, "type": "string" }, "rules": { "description": "[Output Only] The rules that apply to the network.", "type": "array", "items": { "$ref": "FirewallPolicyRule" } }, "packetMirroringRules": { "description": "[Output Only] The packet mirroring rules that apply to the network.", "type": "array", "items": { "$ref": "FirewallPolicyRule" } }, "priority": { "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", "type": "integer", "format": "int32" } } }, "ExchangedPeeringRoutesList": { "id": "ExchangedPeeringRoutesList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#exchangedPeeringRoutesList for exchanged peering routes lists.", "default": "compute#exchangedPeeringRoutesList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of ExchangedPeeringRoute resources.", "type": "array", "items": { "$ref": "ExchangedPeeringRoute" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "ExchangedPeeringRoute": { "id": "ExchangedPeeringRoute", "type": "object", "properties": { "destRange": { "description": "The destination range of the route.", "type": "string" }, "type": { "description": "The type of the peering route.", "type": "string", "enumDescriptions": [ "For routes exported from local network.", "The peering route.", "The peering route corresponding to subnetwork range." ], "enum": [ "DYNAMIC_PEERING_ROUTE", "STATIC_PEERING_ROUTE", "SUBNET_PEERING_ROUTE" ] }, "nextHopRegion": { "description": "The region of peering route next hop, only applies to dynamic routes.", "type": "string" }, "priority": { "description": "The priority of the peering route.", "type": "integer", "format": "uint32" }, "imported": { "description": "True if the peering route has been imported from a peer. The actual import happens if the field networkPeering.importCustomRoutes is true for this network, and networkPeering.exportCustomRoutes is true for the peer network, and the import does not result in a route conflict.", "type": "boolean" } } }, "NodeGroupList": { "id": "NodeGroupList", "description": "Contains a list of nodeGroups.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups.", "default": "compute#nodeGroupList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of NodeGroup resources.", "type": "array", "items": { "$ref": "NodeGroup" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NodeGroup": { "id": "NodeGroup", "description": "Represents a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes.", "type": "object", "properties": { "kind": { "description": "[Output Only] The type of the resource. Always compute#nodeGroup for node group.", "default": "compute#nodeGroup", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "nodeTemplate": { "description": "URL of the node template to create the node group from.", "type": "string" }, "zone": { "description": "[Output Only] The name of the zone where the node group resides, such as us-central1-a.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "status": { "type": "string", "enumDescriptions": [ "", "", "", "" ], "enum": [ "CREATING", "DELETING", "INVALID", "READY" ] }, "size": { "description": "[Output Only] The total number of nodes in the node group.", "type": "integer", "format": "int32" }, "autoscalingPolicy": { "description": "Specifies how autoscaling should behave.", "$ref": "NodeGroupAutoscalingPolicy" }, "maintenancePolicy": { "description": "Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.", "type": "string", "enumDescriptions": [ "Allow the node and corresponding instances to retain default maintenance behavior.", "", "When maintenance must be done on a node, the instances on that node will be moved to other nodes in the group. Instances with onHostMaintenance = MIGRATE will live migrate to their destinations while instances with onHostMaintenance = TERMINATE will terminate and then restart on their destination nodes if automaticRestart = true.", "Instances in this group will restart on the same node when maintenance has completed. Instances must have onHostMaintenance = TERMINATE, and they will only restart if automaticRestart = true." ], "enum": [ "DEFAULT", "MAINTENANCE_POLICY_UNSPECIFIED", "MIGRATE_WITHIN_NODE_GROUP", "RESTART_IN_PLACE" ] }, "locationHint": { "description": "An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.", "type": "string" }, "fingerprint": { "type": "string", "format": "byte" }, "maintenanceWindow": { "$ref": "NodeGroupMaintenanceWindow" }, "shareSettings": { "description": "Share-settings for the node group", "$ref": "ShareSettings" }, "maintenanceInterval": { "description": "Specifies the frequency of planned maintenance events. The accepted values are: `AS_NEEDED` and `RECURRENT`.", "type": "string", "enumDescriptions": [ "VMs are eligible to receive infrastructure and hypervisor updates as they become available. This may result in more maintenance operations (live migrations or terminations) for the VM than the PERIODIC and RECURRENT options.", "VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. This may mean a VM will take longer to receive an update than if it was configured for AS_NEEDED. Security updates will still be applied as soon as they are available. RECURRENT is used for GEN3 and Slice of Hardware VMs." ], "enum": [ "AS_NEEDED", "RECURRENT" ] } } }, "NodeGroupAutoscalingPolicy": { "id": "NodeGroupAutoscalingPolicy", "type": "object", "properties": { "mode": { "description": "The autoscaling mode. Set to one of: ON, OFF, or ONLY_SCALE_OUT. For more information, see Autoscaler modes.", "type": "string", "enumDescriptions": [ "", "Autoscaling is disabled.", "Autocaling is fully enabled.", "Autoscaling will only scale out and will not remove nodes." ], "enum": [ "MODE_UNSPECIFIED", "OFF", "ON", "ONLY_SCALE_OUT" ] }, "minNodes": { "description": "The minimum number of nodes that the group should have.", "type": "integer", "format": "int32" }, "maxNodes": { "description": "The maximum number of nodes that the group should have. Must be set if autoscaling is enabled. Maximum value allowed is 100.", "type": "integer", "format": "int32" } } }, "NodeGroupMaintenanceWindow": { "id": "NodeGroupMaintenanceWindow", "description": "Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window.", "type": "object", "properties": { "startTime": { "description": "Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.", "type": "string" }, "maintenanceDuration": { "description": "[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.", "$ref": "Duration" } } }, "NodeGroupAggregatedList": { "id": "NodeGroupAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups.", "default": "compute#nodeGroupAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of NodeGroupsScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of node groups.", "$ref": "NodeGroupsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "NodeGroupsScopedList": { "id": "NodeGroupsScopedList", "type": "object", "properties": { "nodeGroups": { "description": "[Output Only] A list of node groups contained in this scope.", "type": "array", "items": { "$ref": "NodeGroup" } }, "warning": { "description": "[Output Only] An informational warning that appears when the nodeGroup list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NodeGroupsAddNodesRequest": { "id": "NodeGroupsAddNodesRequest", "type": "object", "properties": { "additionalNodeCount": { "description": "Count of additional nodes to be added to the node group.", "type": "integer", "format": "int32" } } }, "NodeGroupsDeleteNodesRequest": { "id": "NodeGroupsDeleteNodesRequest", "type": "object", "properties": { "nodes": { "description": "Names of the nodes to delete.", "type": "array", "items": { "type": "string" } } } }, "NodeGroupsListNodes": { "id": "NodeGroupsListNodes", "type": "object", "properties": { "kind": { "description": "[Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group.", "default": "compute#nodeGroupsListNodes", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Node resources.", "type": "array", "items": { "$ref": "NodeGroupNode" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NodeGroupNode": { "id": "NodeGroupNode", "type": "object", "properties": { "name": { "description": "The name of the node.", "type": "string" }, "status": { "type": "string", "enumDescriptions": [ "", "", "", "", "" ], "enum": [ "CREATING", "DELETING", "INVALID", "READY", "REPAIRING" ] }, "nodeType": { "description": "The type of this node.", "type": "string" }, "serverBinding": { "description": "Binding properties for the physical server.", "$ref": "ServerBinding" }, "serverId": { "description": "Server ID associated with this node.", "type": "string" }, "disks": { "description": "Local disk configurations.", "type": "array", "items": { "$ref": "LocalDisk" } }, "accelerators": { "description": "Accelerators for this node.", "type": "array", "items": { "$ref": "AcceleratorConfig" } }, "instances": { "description": "Instances scheduled on this node.", "type": "array", "items": { "type": "string" } }, "instanceConsumptionData": { "description": "Instance data that shows consumed resources on the node.", "type": "array", "items": { "$ref": "InstanceConsumptionData" } }, "consumedResources": { "description": "Node resources that are reserved by all instances.", "$ref": "InstanceConsumptionInfo" }, "totalResources": { "description": "Total amount of available resources on the node.", "$ref": "InstanceConsumptionInfo" }, "cpuOvercommitType": { "description": "CPU overcommit.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "CPU_OVERCOMMIT_TYPE_UNSPECIFIED", "ENABLED", "NONE" ] }, "satisfiesPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "upcomingMaintenance": { "description": "[Output Only] The information about an upcoming maintenance event.", "$ref": "UpcomingMaintenance" } } }, "ServerBinding": { "id": "ServerBinding", "type": "object", "properties": { "type": { "type": "string", "enumDescriptions": [ "Node may associate with any physical server over its lifetime.", "Node may associate with minimal physical servers over its lifetime.", "" ], "enum": [ "RESTART_NODE_ON_ANY_SERVER", "RESTART_NODE_ON_MINIMAL_SERVERS", "SERVER_BINDING_TYPE_UNSPECIFIED" ] } } }, "LocalDisk": { "id": "LocalDisk", "type": "object", "properties": { "diskType": { "description": "Specifies the desired disk type on the node. This disk type must be a local storage type (e.g.: local-ssd). Note that for nodeTemplates, this should be the name of the disk type and not its URL.", "type": "string" }, "diskSizeGb": { "description": "Specifies the size of the disk in base-2 GB.", "type": "integer", "format": "int32" }, "diskCount": { "description": "Specifies the number of such disks.", "type": "integer", "format": "int32" } } }, "InstanceConsumptionData": { "id": "InstanceConsumptionData", "type": "object", "properties": { "instance": { "description": "Server-defined URL for the instance.", "type": "string" }, "consumptionInfo": { "description": "Resources consumed by the instance.", "$ref": "InstanceConsumptionInfo" } } }, "InstanceConsumptionInfo": { "id": "InstanceConsumptionInfo", "type": "object", "properties": { "minNodeCpus": { "description": "The minimal guaranteed number of virtual CPUs that are reserved.", "type": "integer", "format": "int32" }, "guestCpus": { "description": "The number of virtual CPUs that are available to the instance.", "type": "integer", "format": "int32" }, "memoryMb": { "description": "The amount of physical memory available to the instance, defined in MiB.", "type": "integer", "format": "int32" }, "localSsdGb": { "description": "The amount of local SSD storage available to the instance, defined in GiB.", "type": "integer", "format": "int32" } } }, "NodeGroupsSetNodeTemplateRequest": { "id": "NodeGroupsSetNodeTemplateRequest", "type": "object", "properties": { "nodeTemplate": { "description": "Full or partial URL of the node template resource to be updated for this node group.", "type": "string" } } }, "NodeGroupsSimulateMaintenanceEventRequest": { "id": "NodeGroupsSimulateMaintenanceEventRequest", "type": "object", "properties": { "nodes": { "description": "Names of the nodes to go under maintenance simulation.", "type": "array", "items": { "type": "string" } } } }, "NodeGroupsPerformMaintenanceRequest": { "id": "NodeGroupsPerformMaintenanceRequest", "type": "object", "properties": { "nodes": { "description": "[Required] List of nodes affected by the call.", "type": "array", "items": { "type": "string" } }, "startTime": { "description": "The start time of the schedule. The timestamp is an RFC3339 string.", "type": "string" } } }, "NodeTemplateList": { "id": "NodeTemplateList", "description": "Contains a list of node templates.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates.", "default": "compute#nodeTemplateList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of NodeTemplate resources.", "type": "array", "items": { "$ref": "NodeTemplate" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NodeTemplate": { "id": "NodeTemplate", "description": "Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances.", "type": "object", "properties": { "kind": { "description": "[Output Only] The type of the resource. Always compute#nodeTemplate for node templates.", "default": "compute#nodeTemplate", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "nodeType": { "description": "The node type to use for nodes group that are created from this template.", "type": "string" }, "nodeAffinityLabels": { "description": "Labels to use for node affinity, which will be used in instance scheduling.", "type": "object", "additionalProperties": { "type": "string" } }, "status": { "description": "[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING.", "type": "string", "enumDescriptions": [ "Resources are being allocated.", "The node template is currently being deleted.", "Invalid status.", "The node template is ready." ], "enum": [ "CREATING", "DELETING", "INVALID", "READY" ] }, "statusMessage": { "description": "[Output Only] An optional, human-readable explanation of the status.", "type": "string" }, "region": { "description": "[Output Only] The name of the region where the node template resides, such as us-central1.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "nodeTypeFlexibility": { "description": "Do not use. Instead, use the node_type property.", "$ref": "NodeTemplateNodeTypeFlexibility" }, "serverBinding": { "description": "Sets the binding properties for the physical server. Valid values include: - [Default]* RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible See Sole-tenant node options for more information.", "$ref": "ServerBinding" }, "disks": { "type": "array", "items": { "$ref": "LocalDisk" } }, "accelerators": { "type": "array", "items": { "$ref": "AcceleratorConfig" } }, "cpuOvercommitType": { "description": "CPU overcommit.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "CPU_OVERCOMMIT_TYPE_UNSPECIFIED", "ENABLED", "NONE" ] } } }, "NodeTemplateNodeTypeFlexibility": { "id": "NodeTemplateNodeTypeFlexibility", "type": "object", "properties": { "cpus": { "type": "string" }, "memory": { "type": "string" }, "localSsd": { "type": "string" } } }, "NodeTemplateAggregatedList": { "id": "NodeTemplateAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates.", "default": "compute#nodeTemplateAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of NodeTemplatesScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of node templates.", "$ref": "NodeTemplatesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "NodeTemplatesScopedList": { "id": "NodeTemplatesScopedList", "type": "object", "properties": { "nodeTemplates": { "description": "[Output Only] A list of node templates contained in this scope.", "type": "array", "items": { "$ref": "NodeTemplate" } }, "warning": { "description": "[Output Only] An informational warning that appears when the node templates list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NodeTypeList": { "id": "NodeTypeList", "description": "Contains a list of node types.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource.Always compute#nodeTypeList for lists of node types.", "default": "compute#nodeTypeList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of NodeType resources.", "type": "array", "items": { "$ref": "NodeType" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NodeType": { "id": "NodeType", "description": "Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types.", "type": "object", "properties": { "kind": { "description": "[Output Only] The type of the resource. Always compute#nodeType for node types.", "default": "compute#nodeType", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "[Output Only] Name of the resource.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "[Output Only] An optional textual description of the resource.", "type": "string" }, "cpuPlatform": { "description": "[Output Only] The CPU platform used by this node type.", "type": "string" }, "guestCpus": { "description": "[Output Only] The number of virtual CPUs that are available to the node type.", "type": "integer", "format": "int32" }, "memoryMb": { "description": "[Output Only] The amount of physical memory available to the node type, defined in MB.", "type": "integer", "format": "int32" }, "localSsdGb": { "description": "[Output Only] Local SSD available to the node type, defined in GB.", "type": "integer", "format": "int32" }, "deprecated": { "description": "[Output Only] The deprecation status associated with this node type.", "$ref": "DeprecationStatus" }, "zone": { "description": "[Output Only] The name of the zone where the node type resides, such as us-central1-a.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "maxVms": { "description": "[Output Only] Maximum number of VMs that can be created for this node type.", "type": "integer", "format": "int32" } } }, "NodeTypeAggregatedList": { "id": "NodeTypeAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types.", "default": "compute#nodeTypeAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of NodeTypesScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of node types.", "$ref": "NodeTypesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "NodeTypesScopedList": { "id": "NodeTypesScopedList", "type": "object", "properties": { "nodeTypes": { "description": "[Output Only] A list of node types contained in this scope.", "type": "array", "items": { "$ref": "NodeType" } }, "warning": { "description": "[Output Only] An informational warning that appears when the node types list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NotificationEndpointList": { "id": "NotificationEndpointList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.", "default": "compute#notificationEndpointList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of NotificationEndpoint resources.", "type": "array", "items": { "$ref": "NotificationEndpoint" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "NotificationEndpoint": { "id": "NotificationEndpoint", "description": "Represents a notification endpoint. A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service. For more information, see Health checks overview.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.", "default": "compute#notificationEndpoint", "type": "string" }, "id": { "description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "grpcSettings": { "description": "Settings of the gRPC notification endpoint including the endpoint URL and the retry duration.", "$ref": "NotificationEndpointGrpcSettings" } } }, "NotificationEndpointGrpcSettings": { "id": "NotificationEndpointGrpcSettings", "description": "Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint.", "type": "object", "properties": { "endpoint": { "description": "Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name.", "type": "string" }, "retryDurationSec": { "description": "How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number.", "type": "integer", "format": "uint32" }, "payloadName": { "description": "Optional. If specified, this field is used to populate the \"name\" field in gRPC requests.", "type": "string" }, "authority": { "description": "Optional. If specified, this field is used to set the authority header by the sender of notifications. See https:\/\/tools.ietf.org\/html\/rfc7540#section-8.1.2.3", "type": "string" }, "resendInterval": { "description": "Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed. Can only be set for regional notification endpoints.", "$ref": "Duration" } } }, "PacketMirroring": { "id": "PacketMirroring", "description": "Represents a Packet Mirroring resource. Packet Mirroring clones the traffic of specified instances in your Virtual Private Cloud (VPC) network and forwards it to a collector destination, such as an instance group of an internal TCP\/UDP load balancer, for analysis or examination. For more information about setting up Packet Mirroring, see Using Packet Mirroring.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.", "default": "compute#packetMirroring", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "name": { "description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.packetMirrorings.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "region": { "description": "[Output Only] URI of the region where the packetMirroring resides.", "type": "string" }, "network": { "description": "Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network.", "annotations": { "required": [ "compute.packetMirrorings.insert" ] }, "$ref": "PacketMirroringNetworkInfo" }, "priority": { "description": "The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.", "type": "integer", "format": "uint32" }, "collectorIlb": { "description": "The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true.", "$ref": "PacketMirroringForwardingRuleInfo" }, "mirroredResources": { "description": "PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and\/or tags for which traffic from\/to all VM instances will be mirrored.", "$ref": "PacketMirroringMirroredResourceInfo" }, "filter": { "description": "Filter for mirrored traffic. If unspecified, all IPv4 traffic is mirrored.", "$ref": "PacketMirroringFilter" }, "enable": { "description": "Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "FALSE", "TRUE" ] } } }, "PacketMirroringNetworkInfo": { "id": "PacketMirroringNetworkInfo", "type": "object", "properties": { "url": { "description": "URL of the network resource.", "type": "string" }, "canonicalUrl": { "description": "[Output Only] Unique identifier for the network; defined by the server.", "type": "string" } } }, "PacketMirroringForwardingRuleInfo": { "id": "PacketMirroringForwardingRuleInfo", "type": "object", "properties": { "url": { "description": "Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic.", "type": "string" }, "canonicalUrl": { "description": "[Output Only] Unique identifier for the forwarding rule; defined by the server.", "type": "string" } } }, "PacketMirroringMirroredResourceInfo": { "id": "PacketMirroringMirroredResourceInfo", "type": "object", "properties": { "subnetworks": { "description": "A set of subnetworks for which traffic from\/to all VM instances will be mirrored. They must live in the same region as this packetMirroring. You may specify a maximum of 5 subnetworks.", "type": "array", "items": { "$ref": "PacketMirroringMirroredResourceInfoSubnetInfo" } }, "instances": { "description": "A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring. Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring. You may specify a maximum of 50 Instances.", "type": "array", "items": { "$ref": "PacketMirroringMirroredResourceInfoInstanceInfo" } }, "tags": { "description": "A set of mirrored tags. Traffic from\/to all VM instances that have one or more of these tags will be mirrored.", "type": "array", "items": { "type": "string" } } } }, "PacketMirroringMirroredResourceInfoSubnetInfo": { "id": "PacketMirroringMirroredResourceInfoSubnetInfo", "type": "object", "properties": { "url": { "description": "Resource URL to the subnetwork for which traffic from\/to all VM instances will be mirrored.", "type": "string" }, "canonicalUrl": { "description": "[Output Only] Unique identifier for the subnetwork; defined by the server.", "type": "string" } } }, "PacketMirroringMirroredResourceInfoInstanceInfo": { "id": "PacketMirroringMirroredResourceInfoInstanceInfo", "type": "object", "properties": { "url": { "description": "Resource URL to the virtual machine instance which is being mirrored.", "type": "string" }, "canonicalUrl": { "description": "[Output Only] Unique identifier for the instance; defined by the server.", "type": "string" } } }, "PacketMirroringFilter": { "id": "PacketMirroringFilter", "type": "object", "properties": { "cidrRanges": { "description": "One or more IPv4 or IPv6 CIDR ranges that apply as filters on the source (ingress) or destination (egress) IP in the IP header. If no ranges are specified, all IPv4 traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all IPv4 traffic is mirrored. To mirror all IPv4 and IPv6 traffic, use \"0.0.0.0\/0,::\/0\".", "type": "array", "items": { "type": "string" } }, "IPProtocols": { "description": "Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all IPv4 traffic is mirrored.", "type": "array", "items": { "type": "string" } }, "direction": { "description": "Direction of traffic to mirror, either INGRESS, EGRESS, or BOTH. The default is BOTH.", "type": "string", "enumDescriptions": [ "Default, both directions are mirrored.", "Only egress traffic is mirrored.", "Only ingress traffic is mirrored." ], "enum": [ "BOTH", "EGRESS", "INGRESS" ] } } }, "PacketMirroringList": { "id": "PacketMirroringList", "description": "Contains a list of PacketMirroring resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#packetMirroring for packetMirrorings.", "default": "compute#packetMirroringList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of PacketMirroring resources.", "type": "array", "items": { "$ref": "PacketMirroring" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "PacketMirroringAggregatedList": { "id": "PacketMirroringAggregatedList", "description": "Contains a list of packetMirrorings.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#packetMirroringAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of PacketMirroring resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of packetMirrorings.", "$ref": "PacketMirroringsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "PacketMirroringsScopedList": { "id": "PacketMirroringsScopedList", "type": "object", "properties": { "packetMirrorings": { "description": "A list of packetMirrorings contained in this scope.", "type": "array", "items": { "$ref": "PacketMirroring" } }, "warning": { "description": "Informational warning which replaces the list of packetMirrorings when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Project": { "id": "Project", "description": "Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#project for projects.", "default": "compute#project", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.", "type": "string" }, "description": { "description": "An optional textual description of the resource.", "type": "string" }, "commonInstanceMetadata": { "description": "Metadata key\/value pairs available to all instances contained in this project. See Custom metadata for more information.", "$ref": "Metadata" }, "quotas": { "description": "[Output Only] Quotas assigned to this project.", "type": "array", "items": { "$ref": "Quota" } }, "usageExportLocation": { "description": "An optional naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.", "$ref": "UsageExportLocation" }, "enabledFeatures": { "description": "An optional list of restricted features enabled for use on this project.", "type": "array", "items": { "type": "string" } }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "defaultServiceAccount": { "description": "[Output Only] Default service account used by VMs running in this project.", "type": "string" }, "xpnProjectStatus": { "description": "[Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "HOST", "UNSPECIFIED_XPN_PROJECT_STATUS" ] }, "defaultNetworkTier": { "description": "This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM.", "type": "string", "enumDescriptions": [ "Public internet quality with fixed bandwidth.", "High quality, Google-grade network tier, support for all networking products.", "Public internet quality, only limited support for other networking products.", "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured." ], "enum": [ "FIXED_STANDARD", "PREMIUM", "STANDARD", "STANDARD_OVERRIDES_FIXED_STANDARD" ] }, "vmDnsSetting": { "description": "[Output Only] Default internal DNS setting used by VMs running in this project.", "type": "string", "enumDescriptions": [ "", "", "", "" ], "enum": [ "GLOBAL_DEFAULT", "UNSPECIFIED_VM_DNS_SETTING", "ZONAL_DEFAULT", "ZONAL_ONLY" ] }, "cloudArmorTier": { "description": "[Output Only] The Cloud Armor tier for this project. It can be one of the following values: CA_STANDARD, CA_ENTERPRISE_PAYGO. If this field is not specified, it is assumed to be CA_STANDARD.", "type": "string", "enumDescriptions": [ "Enterprise tier protection billed annually.", "Enterprise tier protection billed monthly.", "Standard protection." ], "enum": [ "CA_ENTERPRISE_ANNUAL", "CA_ENTERPRISE_PAYGO", "CA_STANDARD" ] } } }, "Quota": { "id": "Quota", "description": "A quotas entry.", "type": "object", "properties": { "metric": { "description": "[Output Only] Name of the quota metric.", "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "Guest CPUs", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "The total number of snapshots allowed for a single project.", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "" ], "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" ] }, "limit": { "description": "[Output Only] Quota limit for this metric.", "type": "number", "format": "double" }, "usage": { "description": "[Output Only] Current usage of this metric.", "type": "number", "format": "double" }, "owner": { "description": "[Output Only] Owning resource. This is the resource on which this quota is applied.", "type": "string" } } }, "UsageExportLocation": { "id": "UsageExportLocation", "description": "The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.", "type": "object", "properties": { "bucketName": { "description": "The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:\/\/ or https:\/\/storage.googleapis.com\/ in front of it, such as gs:\/\/example-bucket.", "type": "string" }, "reportNamePrefix": { "description": "An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage_gce. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.", "type": "string" } } }, "InstanceMoveRequest": { "id": "InstanceMoveRequest", "type": "object", "properties": { "targetInstance": { "description": "The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/instances\/instance - projects\/project\/zones\/zone\/instances\/instance - zones\/zone\/instances\/instance ", "type": "string" }, "destinationZone": { "description": "The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone - projects\/project\/zones\/zone - zones\/zone ", "type": "string" } } }, "DiskMoveRequest": { "id": "DiskMoveRequest", "type": "object", "properties": { "targetDisk": { "description": "The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/disks\/disk - projects\/project\/zones\/zone\/disks\/disk - zones\/zone\/disks\/disk ", "type": "string" }, "destinationZone": { "description": "The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone - projects\/project\/zones\/zone - zones\/zone ", "type": "string" } } }, "ProjectsListXpnHostsRequest": { "id": "ProjectsListXpnHostsRequest", "type": "object", "properties": { "organization": { "description": "Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project.", "type": "string" } } }, "XpnHostList": { "id": "XpnHostList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts.", "default": "compute#xpnHostList", "type": "string" }, "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.", "type": "array", "items": { "$ref": "Project" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "ProjectsEnableXpnResourceRequest": { "id": "ProjectsEnableXpnResourceRequest", "type": "object", "properties": { "xpnResource": { "description": "Service resource (a.k.a service project) ID.", "$ref": "XpnResourceId" } } }, "XpnResourceId": { "id": "XpnResourceId", "description": "Service resource (a.k.a service project) ID.", "type": "object", "properties": { "type": { "description": "The type of the service resource.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "PROJECT", "XPN_RESOURCE_TYPE_UNSPECIFIED" ] }, "id": { "description": "The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678).", "type": "string" } } }, "ProjectsDisableXpnResourceRequest": { "id": "ProjectsDisableXpnResourceRequest", "type": "object", "properties": { "xpnResource": { "description": "Service resource (a.k.a service project) ID.", "$ref": "XpnResourceId" } } }, "ProjectsGetXpnResources": { "id": "ProjectsGetXpnResources", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects)", "default": "compute#projectsGetXpnResources", "type": "string" }, "resources": { "description": "Service resources (a.k.a service projects) attached to this project as their shared VPC host.", "type": "array", "items": { "$ref": "XpnResourceId" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" } } }, "ProjectsSetDefaultNetworkTierRequest": { "id": "ProjectsSetDefaultNetworkTierRequest", "type": "object", "properties": { "networkTier": { "description": "Default network tier to be set.", "type": "string", "enumDescriptions": [ "Public internet quality with fixed bandwidth.", "High quality, Google-grade network tier, support for all networking products.", "Public internet quality, only limited support for other networking products.", "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured." ], "enum": [ "FIXED_STANDARD", "PREMIUM", "STANDARD", "STANDARD_OVERRIDES_FIXED_STANDARD" ] } } }, "ProjectsSetCloudArmorTierRequest": { "id": "ProjectsSetCloudArmorTierRequest", "type": "object", "properties": { "cloudArmorTier": { "description": "Managed protection tier to be set.", "type": "string", "enumDescriptions": [ "Enterprise tier protection billed annually.", "Enterprise tier protection billed monthly.", "Standard protection." ], "enum": [ "CA_ENTERPRISE_ANNUAL", "CA_ENTERPRISE_PAYGO", "CA_STANDARD" ] } } }, "PublicAdvertisedPrefixList": { "id": "PublicAdvertisedPrefixList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.", "default": "compute#publicAdvertisedPrefixList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of PublicAdvertisedPrefix resources.", "type": "array", "items": { "$ref": "PublicAdvertisedPrefix" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "PublicAdvertisedPrefix": { "id": "PublicAdvertisedPrefix", "description": "A public advertised prefix represents an aggregated IP prefix or netblock which customers bring to cloud. The IP prefix is a single unit of route advertisement and is announced globally to the internet.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes.", "default": "compute#publicAdvertisedPrefix", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.publicAdvertisedPrefixes.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "ipCidrRange": { "description": "The address range, in CIDR format, represented by this public advertised prefix.", "type": "string" }, "dnsVerificationIp": { "description": "The address to be used for reverse DNS verification.", "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: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed. ", "type": "string", "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." ], "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" ] }, "pdpScope": { "description": "Specifies how child public delegated prefix will be scoped. It could be one of following values: - `REGIONAL`: The public delegated prefix is regional only. The provisioning will take a few minutes. - `GLOBAL`: The public delegated prefix is global only. The provisioning will take ~4 weeks. - `GLOBAL_AND_REGIONAL` [output only]: The public delegated prefixes is BYOIP V1 legacy prefix. This is output only value and no longer supported in BYOIP V2. ", "type": "string", "enumDescriptions": [ "The public delegated prefix is global only. The provisioning will take ~4 weeks.", "The public delegated prefixes is BYOIP V1 legacy prefix. This is output only value and no longer supported in BYOIP V2.", "The public delegated prefix is regional only. The provisioning will take a few minutes." ], "enum": [ "GLOBAL", "GLOBAL_AND_REGIONAL", "REGIONAL" ] }, "publicDelegatedPrefixs": { "description": "[Output Only] The list of public delegated prefixes that exist for this public advertised prefix.", "type": "array", "items": { "$ref": "PublicAdvertisedPrefixPublicDelegatedPrefix" } }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix.", "type": "string", "format": "byte" }, "byoipApiVersion": { "description": "[Output Only] The version of BYOIP API.", "type": "string", "enumDescriptions": [ "This public advertised prefix can be used to create both regional and global public delegated prefixes. It usually takes 4 weeks to create or delete a public delegated prefix. The BGP status cannot be changed.", "This public advertised prefix can only be used to create regional public delegated prefixes. Public delegated prefix creation and deletion takes minutes and the BGP status can be modified." ], "enum": [ "V1", "V2" ] } } }, "PublicAdvertisedPrefixPublicDelegatedPrefix": { "id": "PublicAdvertisedPrefixPublicDelegatedPrefix", "description": "Represents a CIDR range which can be used to assign addresses.", "type": "object", "properties": { "name": { "description": "The name of the public delegated prefix", "type": "string" }, "region": { "description": "The region of the public delegated prefix if it is regional. If absent, the prefix is global.", "type": "string" }, "project": { "description": "The project number of the public delegated prefix", "type": "string" }, "status": { "description": "The status of the public delegated prefix. Possible values are: INITIALIZING: The public delegated prefix is being initialized and addresses cannot be created yet. ANNOUNCED: The public delegated prefix is active.", "type": "string" }, "ipRange": { "description": "The IP address range of the public delegated prefix", "type": "string" } } }, "PublicDelegatedPrefixList": { "id": "PublicDelegatedPrefixList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#publicDelegatedPrefixList for public delegated prefixes.", "default": "compute#publicDelegatedPrefixList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of PublicDelegatedPrefix resources.", "type": "array", "items": { "$ref": "PublicDelegatedPrefix" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "PublicDelegatedPrefix": { "id": "PublicDelegatedPrefix", "description": "A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes.", "default": "compute#publicDelegatedPrefix", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.publicDelegatedPrefixes.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "ipCidrRange": { "description": "The IP address range, in CIDR format, represented by this public delegated prefix.", "type": "string" }, "status": { "description": "[Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. ", "type": "string", "enumDescriptions": [ "The public delegated prefix is active.", "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 created yet.", "The public delegated prefix is currently withdrawn but ready to be announced." ], "enum": [ "ANNOUNCED", "ANNOUNCED_TO_GOOGLE", "ANNOUNCED_TO_INTERNET", "DELETING", "INITIALIZING", "READY_TO_ANNOUNCE" ] }, "parentPrefix": { "description": "The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix.", "type": "string" }, "publicDelegatedSubPrefixs": { "description": "The list of sub public delegated prefixes that exist for this public delegated prefix.", "type": "array", "items": { "$ref": "PublicDelegatedPrefixPublicDelegatedSubPrefix" } }, "isLiveMigration": { "description": "If true, the prefix will be live migrated.", "type": "boolean" }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix.", "type": "string", "format": "byte" }, "mode": { "description": "The public delegated prefix mode for IPv6 only.", "type": "string", "enumDescriptions": [ "The public delegated prefix is used for further sub-delegation only. Such prefixes cannot set allocatablePrefixLength.", "The public delegated prefix is used for creating forwarding rules only. Such prefixes cannot set publicDelegatedSubPrefixes." ], "enum": [ "DELEGATION", "EXTERNAL_IPV6_FORWARDING_RULE_CREATION" ] }, "allocatablePrefixLength": { "description": "The allocatable prefix length supported by this public delegated prefix. This field is optional and cannot be set for prefixes in DELEGATION mode. It cannot be set for IPv4 prefixes either, and it always defaults to 32.", "type": "integer", "format": "int32" }, "byoipApiVersion": { "description": "[Output Only] The version of BYOIP API.", "type": "string", "enumDescriptions": [ "This public delegated prefix usually takes 4 weeks to delete, and the BGP status cannot be changed. Announce and Withdraw APIs can not be used on this prefix.", "This public delegated prefix takes minutes to delete. Announce and Withdraw APIs can be used on this prefix to change the BGP status." ], "enum": [ "V1", "V2" ] } } }, "PublicDelegatedPrefixPublicDelegatedSubPrefix": { "id": "PublicDelegatedPrefixPublicDelegatedSubPrefix", "description": "Represents a sub PublicDelegatedPrefix.", "type": "object", "properties": { "name": { "description": "The name of the sub public delegated prefix.", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "region": { "description": "[Output Only] The region of the sub public delegated prefix if it is regional. If absent, the sub prefix is global.", "type": "string" }, "status": { "description": "[Output Only] The status of the sub public delegated prefix.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "ACTIVE", "INACTIVE" ] }, "ipCidrRange": { "description": "The IP address range, in CIDR format, represented by this sub public delegated prefix.", "type": "string" }, "delegateeProject": { "description": "Name of the project scoping this PublicDelegatedSubPrefix.", "type": "string" }, "isAddress": { "description": "Whether the sub prefix is delegated to create Address resources in the delegatee project.", "type": "boolean" }, "mode": { "description": "The PublicDelegatedSubPrefix mode for IPv6 only.", "type": "string", "enumDescriptions": [ "The public delegated prefix is used for further sub-delegation only. Such prefixes cannot set allocatablePrefixLength.", "The public delegated prefix is used for creating forwarding rules only. Such prefixes cannot set publicDelegatedSubPrefixes." ], "enum": [ "DELEGATION", "EXTERNAL_IPV6_FORWARDING_RULE_CREATION" ] }, "allocatablePrefixLength": { "description": "The allocatable prefix length supported by this PublicDelegatedSubPrefix.", "type": "integer", "format": "int32" } } }, "PublicDelegatedPrefixAggregatedList": { "id": "PublicDelegatedPrefixAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#publicDelegatedPrefixAggregatedList for aggregated lists of public delegated prefixes.", "default": "compute#publicDelegatedPrefixAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of PublicDelegatedPrefixesScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of PublicDelegatedPrefixes.", "$ref": "PublicDelegatedPrefixesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "PublicDelegatedPrefixesScopedList": { "id": "PublicDelegatedPrefixesScopedList", "type": "object", "properties": { "publicDelegatedPrefixes": { "description": "[Output Only] A list of PublicDelegatedPrefixes contained in this scope.", "type": "array", "items": { "$ref": "PublicDelegatedPrefix" } }, "warning": { "description": "[Output Only] Informational warning which replaces the list of public delegated prefixes when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "RegionList": { "id": "RegionList", "description": "Contains a list of region resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#regionList for lists of regions.", "default": "compute#regionList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Region resources.", "type": "array", "items": { "$ref": "Region" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Region": { "id": "Region", "description": "Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#region for regions.", "default": "compute#region", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "[Output Only] Name of the resource.", "type": "string" }, "description": { "description": "[Output Only] Textual description of the resource.", "type": "string" }, "status": { "description": "[Output Only] Status of the region, either UP or DOWN.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "DOWN", "UP" ] }, "zones": { "description": "[Output Only] A list of zones available in this region, in the form of resource URLs.", "type": "array", "items": { "type": "string" } }, "quotas": { "description": "[Output Only] Quotas assigned to this region.", "type": "array", "items": { "$ref": "Quota" } }, "deprecated": { "description": "[Output Only] The deprecation status associated with this region.", "$ref": "DeprecationStatus" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "supportsPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" }, "quotaStatusWarning": { "description": "[Output Only] Warning of fetching the `quotas` field for this region. This field is populated only if fetching of the `quotas` field fails.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "SubnetworkList": { "id": "SubnetworkList", "description": "Contains a list of Subnetwork resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.", "default": "compute#subnetworkList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Subnetwork resources.", "type": "array", "items": { "$ref": "Subnetwork" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Subnetwork": { "id": "Subnetwork", "description": "Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.", "default": "compute#subnetwork", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.", "type": "string" }, "network": { "description": "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time.", "type": "string" }, "ipCidrRange": { "description": "The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0\/8 or 100.64.0.0\/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.", "type": "string" }, "reservedInternalRange": { "description": "The URL of the reserved internal range.", "type": "string" }, "gatewayAddress": { "description": "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.", "type": "string" }, "region": { "description": "URL of the region where the Subnetwork resides. This field can be set only at resource creation time.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "privateIpGoogleAccess": { "description": "Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess.", "type": "boolean" }, "secondaryIpRanges": { "description": "An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request.", "type": "array", "items": { "$ref": "SubnetworkSecondaryRange" } }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork.", "type": "string", "format": "byte" }, "enableFlowLogs": { "description": "Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.", "type": "boolean" }, "privateIpv6GoogleAccess": { "description": "This field is for internal use. This field can be both set at resource creation time and updated using patch.", "type": "string", "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." ], "enum": [ "DISABLE_GOOGLE_ACCESS", "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE", "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE" ] }, "ipv6CidrRange": { "description": "[Output Only] This field is for internal use.", "type": "string" }, "externalIpv6Prefix": { "description": "The external IPv6 address range that is owned by this subnetwork.", "type": "string" }, "internalIpv6Prefix": { "description": "The internal IPv6 address range that is owned by this subnetwork.", "type": "string" }, "purpose": { "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", "type": "string", "enumDescriptions": [ "Subnet reserved for Global Envoy-based Load Balancing.", "Subnet reserved for Internal HTTP(S) Load Balancing. This is a legacy purpose, please use REGIONAL_MANAGED_PROXY instead.", "Subnetwork will be used for Migration from one peered VPC to another. (a transient state of subnetwork while 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." ], "enum": [ "GLOBAL_MANAGED_PROXY", "INTERNAL_HTTPS_LOAD_BALANCER", "PEER_MIGRATION", "PRIVATE", "PRIVATE_NAT", "PRIVATE_RFC_1918", "PRIVATE_SERVICE_CONNECT", "REGIONAL_MANAGED_PROXY" ] }, "role": { "description": "The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.", "type": "string", "enumDescriptions": [ "The ACTIVE subnet that is currently used.", "The BACKUP subnet that could be promoted to ACTIVE." ], "enum": [ "ACTIVE", "BACKUP" ] }, "state": { "description": "[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY", "type": "string", "enumDescriptions": [ "Subnetwork is being drained.", "Subnetwork is ready for use." ], "enum": [ "DRAINING", "READY" ] }, "logConfig": { "description": "This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.", "$ref": "SubnetworkLogConfig" }, "stackType": { "description": "The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch.", "type": "string", "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." ], "enum": [ "IPV4_IPV6", "IPV4_ONLY", "IPV6_ONLY" ] }, "ipv6AccessType": { "description": "The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack.", "type": "string", "enumDescriptions": [ "VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.", "VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network." ], "enum": [ "EXTERNAL", "INTERNAL" ] } } }, "SubnetworkSecondaryRange": { "id": "SubnetworkSecondaryRange", "description": "Represents a secondary IP range of a subnetwork.", "type": "object", "properties": { "rangeName": { "description": "The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.", "type": "string" }, "ipCidrRange": { "description": "The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported. The range can be any range listed in the Valid ranges list.", "type": "string" }, "reservedInternalRange": { "description": "The URL of the reserved internal range.", "type": "string" } } }, "SubnetworkLogConfig": { "id": "SubnetworkLogConfig", "description": "The available logging options for this subnetwork.", "type": "object", "properties": { "enable": { "description": "Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. Flow logging isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.", "type": "boolean" }, "aggregationInterval": { "description": "Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection.", "type": "string", "enumDescriptions": [ "", "", "", "", "", "" ], "enum": [ "INTERVAL_10_MIN", "INTERVAL_15_MIN", "INTERVAL_1_MIN", "INTERVAL_30_SEC", "INTERVAL_5_MIN", "INTERVAL_5_SEC" ] }, "flowSampling": { "description": "Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5 unless otherwise specified by the org policy, which means half of all collected logs are reported.", "type": "number", "format": "float" }, "metadata": { "description": "Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is EXCLUDE_ALL_METADATA.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "CUSTOM_METADATA", "EXCLUDE_ALL_METADATA", "INCLUDE_ALL_METADATA" ] }, "metadataFields": { "description": "Can only be specified if VPC flow logs for this subnetwork is enabled and \"metadata\" was set to CUSTOM_METADATA.", "type": "array", "items": { "type": "string" } }, "filterExpr": { "description": "Can only be specified if VPC flow logs for this subnetwork is enabled. The filter expression is used to define which VPC flow logs should be exported to Cloud Logging.", "type": "string" } } }, "SubnetworkAggregatedList": { "id": "SubnetworkAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.", "default": "compute#subnetworkAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of SubnetworksScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of Subnetworks.", "$ref": "SubnetworksScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "SubnetworksScopedList": { "id": "SubnetworksScopedList", "type": "object", "properties": { "subnetworks": { "description": "A list of subnetworks contained in this scope.", "type": "array", "items": { "$ref": "Subnetwork" } }, "warning": { "description": "An informational warning that appears when the list of addresses is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "UsableSubnetworksAggregatedList": { "id": "UsableSubnetworksAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks.", "default": "compute#usableSubnetworksAggregatedList", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string" }, "items": { "description": "[Output] A list of usable subnetwork URLs.", "type": "array", "items": { "$ref": "UsableSubnetwork" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. In special cases listUsable may return 0 subnetworks and nextPageToken which still should be used to get the next page of results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "UsableSubnetwork": { "id": "UsableSubnetwork", "description": "Subnetwork which the current user has compute.subnetworks.use permission on.", "type": "object", "properties": { "subnetwork": { "description": "Subnetwork URL.", "type": "string" }, "network": { "description": "Network URL.", "type": "string" }, "ipCidrRange": { "description": "The range of internal addresses that are owned by this subnetwork.", "type": "string" }, "secondaryIpRanges": { "description": "Secondary IP ranges.", "type": "array", "items": { "$ref": "UsableSubnetworkSecondaryRange" } }, "stackType": { "description": "The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch.", "type": "string", "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." ], "enum": [ "IPV4_IPV6", "IPV4_ONLY", "IPV6_ONLY" ] }, "ipv6AccessType": { "description": "The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack.", "type": "string", "enumDescriptions": [ "VMs on this subnet will be assigned IPv6 addresses that are accessible via the Internet, as well as the VPC network.", "VMs on this subnet will be assigned IPv6 addresses that are only accessible over the VPC network." ], "enum": [ "EXTERNAL", "INTERNAL" ] }, "purpose": { "description": "The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION, PRIVATE_SERVICE_CONNECT or PRIVATE_NAT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. A subnet with purpose set to PRIVATE_NAT is used for Private NAT IP address by Private NAT Gateway. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY.", "type": "string", "enumDescriptions": [ "Subnet reserved for Global Envoy-based Load Balancing.", "Subnet reserved for Internal HTTP(S) Load Balancing. This is a legacy purpose, please use REGIONAL_MANAGED_PROXY instead.", "Subnetwork will be used for Migration from one peered VPC to another. (a transient state of subnetwork while 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." ], "enum": [ "GLOBAL_MANAGED_PROXY", "INTERNAL_HTTPS_LOAD_BALANCER", "PEER_MIGRATION", "PRIVATE", "PRIVATE_NAT", "PRIVATE_RFC_1918", "PRIVATE_SERVICE_CONNECT", "REGIONAL_MANAGED_PROXY" ] }, "role": { "description": "The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.", "type": "string", "enumDescriptions": [ "The ACTIVE subnet that is currently used.", "The BACKUP subnet that could be promoted to ACTIVE." ], "enum": [ "ACTIVE", "BACKUP" ] }, "externalIpv6Prefix": { "description": "[Output Only] The external IPv6 address range that is assigned to this subnetwork.", "type": "string" }, "internalIpv6Prefix": { "description": "[Output Only] The internal IPv6 address range that is assigned to this subnetwork.", "type": "string" } } }, "UsableSubnetworkSecondaryRange": { "id": "UsableSubnetworkSecondaryRange", "description": "Secondary IP range of a usable subnetwork.", "type": "object", "properties": { "rangeName": { "description": "The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.", "type": "string" }, "ipCidrRange": { "description": "The range of IP addresses belonging to this subnetwork secondary range.", "type": "string" } } }, "SubnetworksExpandIpCidrRangeRequest": { "id": "SubnetworksExpandIpCidrRangeRequest", "type": "object", "properties": { "ipCidrRange": { "description": "The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update.", "type": "string" } } }, "SubnetworksSetPrivateIpGoogleAccessRequest": { "id": "SubnetworksSetPrivateIpGoogleAccessRequest", "type": "object", "properties": { "privateIpGoogleAccess": { "type": "boolean" } } }, "ResourcePolicyList": { "id": "ResourcePolicyList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies", "default": "compute#resourcePolicyList", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string" }, "items": { "description": "[Output Only] A list of ResourcePolicy resources.", "type": "array", "items": { "$ref": "ResourcePolicy" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "etag": { "type": "string" } } }, "ResourcePolicy": { "id": "ResourcePolicy", "description": "Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.", "type": "object", "properties": { "snapshotSchedulePolicy": { "description": "Resource policy for persistent disks for creating snapshots.", "$ref": "ResourcePolicySnapshotSchedulePolicy" }, "groupPlacementPolicy": { "description": "Resource policy for instances for placement configuration.", "$ref": "ResourcePolicyGroupPlacementPolicy" }, "instanceSchedulePolicy": { "description": "Resource policy for scheduling instance operations.", "$ref": "ResourcePolicyInstanceSchedulePolicy" }, "diskConsistencyGroupPolicy": { "description": "Resource policy for disk consistency groups.", "$ref": "ResourcePolicyDiskConsistencyGroupPolicy" }, "kind": { "description": "[Output Only] Type of the resource. Always compute#resource_policies for resource policies.", "default": "compute#resourcePolicy", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" }, "region": { "type": "string" }, "description": { "type": "string" }, "name": { "description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.instances.insert" ] }, "type": "string" }, "status": { "description": "[Output Only] The status of resource policy creation.", "type": "string", "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." ], "enum": [ "CREATING", "DELETING", "EXPIRED", "INVALID", "READY" ] }, "resourceStatus": { "description": "[Output Only] The system status of the resource policy.", "$ref": "ResourcePolicyResourceStatus" } } }, "ResourcePolicySnapshotSchedulePolicy": { "id": "ResourcePolicySnapshotSchedulePolicy", "description": "A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained.", "type": "object", "properties": { "schedule": { "description": "A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy.", "$ref": "ResourcePolicySnapshotSchedulePolicySchedule" }, "retentionPolicy": { "description": "Retention policy applied to snapshots created by this resource policy.", "$ref": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy" }, "snapshotProperties": { "description": "Properties with which snapshots are created such as labels, encryption keys.", "$ref": "ResourcePolicySnapshotSchedulePolicySnapshotProperties" } } }, "ResourcePolicySnapshotSchedulePolicySchedule": { "id": "ResourcePolicySnapshotSchedulePolicySchedule", "description": "A schedule for disks where the schedueled operations are performed.", "type": "object", "properties": { "hourlySchedule": { "$ref": "ResourcePolicyHourlyCycle" }, "dailySchedule": { "$ref": "ResourcePolicyDailyCycle" }, "weeklySchedule": { "$ref": "ResourcePolicyWeeklyCycle" } } }, "ResourcePolicyHourlyCycle": { "id": "ResourcePolicyHourlyCycle", "description": "Time window specified for hourly operations.", "type": "object", "properties": { "hoursInCycle": { "description": "Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.", "type": "integer", "format": "int32" }, "startTime": { "description": "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT.", "type": "string" }, "duration": { "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.", "type": "string" } } }, "ResourcePolicyDailyCycle": { "id": "ResourcePolicyDailyCycle", "description": "Time window specified for daily operations.", "type": "object", "properties": { "daysInCycle": { "description": "Defines a schedule with units measured in days. The value determines how many days pass between the start of each cycle.", "type": "integer", "format": "int32" }, "startTime": { "description": "Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.", "type": "string" }, "duration": { "description": "[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.", "type": "string" } } }, "ResourcePolicyWeeklyCycle": { "id": "ResourcePolicyWeeklyCycle", "description": "Time window specified for weekly operations.", "type": "object", "properties": { "dayOfWeeks": { "description": "Up to 7 intervals\/windows, one for each day of the week.", "type": "array", "items": { "$ref": "ResourcePolicyWeeklyCycleDayOfWeek" } } } }, "ResourcePolicyWeeklyCycleDayOfWeek": { "id": "ResourcePolicyWeeklyCycleDayOfWeek", "type": "object", "properties": { "day": { "description": "Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.", "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "" ], "enum": [ "FRIDAY", "INVALID", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY" ] }, "startTime": { "description": "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT.", "type": "string" }, "duration": { "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.", "type": "string" } } }, "ResourcePolicySnapshotSchedulePolicyRetentionPolicy": { "id": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy", "description": "Policy for retention of scheduled snapshots.", "type": "object", "properties": { "maxRetentionDays": { "description": "Maximum age of the snapshot that is allowed to be kept.", "type": "integer", "format": "int32" }, "onSourceDiskDelete": { "description": "Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "APPLY_RETENTION_POLICY", "KEEP_AUTO_SNAPSHOTS", "UNSPECIFIED_ON_SOURCE_DISK_DELETE" ] } } }, "ResourcePolicySnapshotSchedulePolicySnapshotProperties": { "id": "ResourcePolicySnapshotSchedulePolicySnapshotProperties", "description": "Specified snapshot properties for scheduled snapshots created by this policy.", "type": "object", "properties": { "labels": { "description": "Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty.", "type": "object", "additionalProperties": { "type": "string" } }, "storageLocations": { "description": "Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional).", "type": "array", "items": { "type": "string" } }, "guestFlush": { "description": "Indication to perform a 'guest aware' snapshot.", "type": "boolean" }, "chainName": { "description": "Chain name that the snapshot is created in.", "type": "string" } } }, "ResourcePolicyGroupPlacementPolicy": { "id": "ResourcePolicyGroupPlacementPolicy", "description": "A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation", "type": "object", "properties": { "vmCount": { "description": "Number of VMs in this placement group. Google does not recommend that you use this field unless you use a compact policy and you want your policy to work only if it contains this exact number of VMs.", "type": "integer", "format": "int32" }, "availabilityDomainCount": { "description": "The number of availability domains to spread instances across. If two instances are in different availability domain, they are not in the same low latency network.", "type": "integer", "format": "int32" }, "collocation": { "description": "Specifies network collocation", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "COLLOCATED", "UNSPECIFIED_COLLOCATION" ] } } }, "ResourcePolicyInstanceSchedulePolicy": { "id": "ResourcePolicyInstanceSchedulePolicy", "description": "An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance.", "type": "object", "properties": { "vmStartSchedule": { "description": "Specifies the schedule for starting instances.", "$ref": "ResourcePolicyInstanceSchedulePolicySchedule" }, "vmStopSchedule": { "description": "Specifies the schedule for stopping instances.", "$ref": "ResourcePolicyInstanceSchedulePolicySchedule" }, "timeZone": { "description": "Specifies the time zone to be used in interpreting Schedule.schedule. The value of this field must be a time zone name from the tz database: https:\/\/wikipedia.org\/wiki\/Tz_database.", "type": "string" }, "startTime": { "description": "The start time of the schedule. The timestamp is an RFC3339 string.", "type": "string" }, "expirationTime": { "description": "The expiration time of the schedule. The timestamp is an RFC3339 string.", "type": "string" } } }, "ResourcePolicyInstanceSchedulePolicySchedule": { "id": "ResourcePolicyInstanceSchedulePolicySchedule", "description": "Schedule for an instance operation.", "type": "object", "properties": { "schedule": { "description": "Specifies the frequency for the operation, using the unix-cron format.", "type": "string" } } }, "ResourcePolicyDiskConsistencyGroupPolicy": { "id": "ResourcePolicyDiskConsistencyGroupPolicy", "description": "Resource policy for disk consistency groups.", "type": "object", "properties": { } }, "ResourcePolicyResourceStatus": { "id": "ResourcePolicyResourceStatus", "description": "Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this \"status\" field should mimic the structure of ResourcePolicy proto specification.", "type": "object", "properties": { "instanceSchedulePolicy": { "description": "[Output Only] Specifies a set of output values reffering to the instance_schedule_policy system status. This field should have the same name as corresponding policy field.", "$ref": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus" } } }, "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus": { "id": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus", "type": "object", "properties": { "nextRunStartTime": { "description": "[Output Only] The next time the schedule is planned to run. The actual time might be slightly different. The timestamp is an RFC3339 string.", "type": "string" }, "lastRunStartTime": { "description": "[Output Only] The last time the schedule successfully ran. The timestamp is an RFC3339 string.", "type": "string" } } }, "ResourcePolicyAggregatedList": { "id": "ResourcePolicyAggregatedList", "description": "Contains a list of resourcePolicies.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#resourcePolicyAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of ResourcePolicy resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of resourcePolicies.", "$ref": "ResourcePoliciesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "etag": { "type": "string" }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "ResourcePoliciesScopedList": { "id": "ResourcePoliciesScopedList", "type": "object", "properties": { "resourcePolicies": { "description": "A list of resourcePolicies contained in this scope.", "type": "array", "items": { "$ref": "ResourcePolicy" } }, "warning": { "description": "Informational warning which replaces the list of resourcePolicies when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "RouteList": { "id": "RouteList", "description": "Contains a list of Route resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#routeList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Route resources.", "type": "array", "items": { "$ref": "Route" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Route": { "id": "Route", "description": "Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of this resource. Always compute#routes for Route resources.", "default": "compute#route", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.routes.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this field when you create the resource.", "type": "string" }, "network": { "description": "Fully-qualified URL of the network that this route applies to.", "annotations": { "required": [ "compute.routes.insert" ] }, "type": "string" }, "tags": { "description": "A list of instance tags to which this route applies.", "annotations": { "required": [ "compute.routes.insert" ] }, "type": "array", "items": { "type": "string" } }, "destRange": { "description": "The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0\/24) or an IPv6 range in RFC 4291 format (e.g. 2001:db8::\/32). IPv6 range will be displayed using RFC 5952 compressed format.", "annotations": { "required": [ "compute.routes.insert" ] }, "type": "string" }, "priority": { "description": "The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.", "annotations": { "required": [ "compute.routes.insert" ] }, "type": "integer", "format": "uint32" }, "nextHopInstance": { "description": "The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone\/instances\/", "type": "string" }, "nextHopIp": { "description": "The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.", "type": "string" }, "nextHopNetwork": { "description": "The URL of the local network if it should handle matching packets.", "type": "string" }, "nextHopGateway": { "description": "The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects\/ project\/global\/gateways\/default-internet-gateway", "type": "string" }, "nextHopPeering": { "description": "[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.", "type": "string" }, "nextHopIlb": { "description": "The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/regions\/region \/forwardingRules\/forwardingRule - regions\/region\/forwardingRules\/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.", "type": "string" }, "warnings": { "description": "[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.", "type": "array", "items": { "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } }, "nextHopVpnTunnel": { "description": "The URL to a VpnTunnel that should handle matching packets.", "type": "string" }, "nextHopHub": { "description": "[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" }, "routeType": { "description": "[Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route", "type": "string", "enumDescriptions": [ "", "", "", "" ], "enum": [ "BGP", "STATIC", "SUBNET", "TRANSIT" ] }, "asPaths": { "description": "[Output Only] AS path.", "type": "array", "items": { "$ref": "RouteAsPath" } }, "routeStatus": { "description": "[Output only] The status of the route.", "type": "string", "enumDescriptions": [ "This route is processed and active.", "The route is dropped due to the VPC exceeding the dynamic route limit. For dynamic route limit, please refer to the Learned route example", "This route is processed but inactive due to failure from the backend. The backend may have rejected the route", "This route is being processed internally. The status will change once processed." ], "enum": [ "ACTIVE", "DROPPED", "INACTIVE", "PENDING" ] }, "nextHopOrigin": { "description": "[Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "EGP", "IGP", "INCOMPLETE" ] }, "nextHopMed": { "description": "[Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.", "type": "integer", "format": "uint32" }, "nextHopInterRegionCost": { "description": "[Output only] Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.", "type": "integer", "format": "uint32" } } }, "RouteAsPath": { "id": "RouteAsPath", "type": "object", "properties": { "pathSegmentType": { "description": "[Output Only] The type of the AS Path, which can be one of the following values: - 'AS_SET': unordered set of autonomous systems that the route in has traversed - 'AS_SEQUENCE': ordered set of autonomous systems that the route has traversed - 'AS_CONFED_SEQUENCE': ordered set of Member Autonomous Systems in the local confederation that the route has traversed - 'AS_CONFED_SET': unordered set of Member Autonomous Systems in the local confederation that the route has traversed ", "type": "string", "enumDescriptions": [ "", "", "", "" ], "enum": [ "AS_CONFED_SEQUENCE", "AS_CONFED_SET", "AS_SEQUENCE", "AS_SET" ] }, "asLists": { "description": "[Output Only] The AS numbers of the AS Path.", "type": "array", "items": { "type": "integer", "format": "uint32" } } } }, "Router": { "id": "Router", "description": "Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#router for routers.", "default": "compute#router", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.routers.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "region": { "description": "[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "network": { "description": "URI of the network to which this router belongs.", "annotations": { "required": [ "compute.routers.insert", "compute.routers.update" ] }, "type": "string" }, "interfaces": { "description": "Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface.", "type": "array", "items": { "$ref": "RouterInterface" } }, "bgpPeers": { "description": "BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.", "type": "array", "items": { "$ref": "RouterBgpPeer" } }, "bgp": { "description": "BGP information specific to this router.", "$ref": "RouterBgp" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "nats": { "description": "A list of NAT services created in this router.", "type": "array", "items": { "$ref": "RouterNat" } }, "encryptedInterconnectRouter": { "description": "Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).", "type": "boolean" }, "md5AuthenticationKeys": { "description": "Keys used for MD5 authentication.", "type": "array", "items": { "$ref": "RouterMd5AuthenticationKey" } } } }, "RouterInterface": { "id": "RouterInterface", "type": "object", "properties": { "name": { "description": "Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.routers.insert" ] }, "type": "string" }, "linkedVpnTunnel": { "description": "URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.", "type": "string" }, "linkedInterconnectAttachment": { "description": "URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.", "type": "string" }, "ipRange": { "description": "IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1\/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::\/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fdff:1::1\/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose. ", "type": "string" }, "managementType": { "description": "[Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. ", "type": "string", "enumDescriptions": [ "The interface is automatically created for PARTNER type InterconnectAttachment, Google will automatically create\/update\/delete this interface when the PARTNER InterconnectAttachment is created\/provisioned\/deleted. This type of interface cannot be manually managed by user.", "Default value, the interface is manually created and managed by user." ], "enum": [ "MANAGED_BY_ATTACHMENT", "MANAGED_BY_USER" ] }, "privateIpAddress": { "description": "The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.", "type": "string" }, "redundantInterface": { "description": "Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "subnetwork": { "description": "The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.", "type": "string" }, "ipVersion": { "description": "IP version of this interface.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "IPV4", "IPV6" ] } } }, "RouterBgpPeer": { "id": "RouterBgpPeer", "type": "object", "properties": { "name": { "description": "Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.routers.insert" ] }, "type": "string" }, "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" }, "peerIpAddress": { "description": "IP address of the BGP interface outside Google Cloud Platform.", "type": "string" }, "peerAsn": { "description": "Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.", "annotations": { "required": [ "compute.routers.insert" ] }, "type": "integer", "format": "uint32" }, "advertisedRoutePriority": { "description": "The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.", "type": "integer", "format": "uint32" }, "advertiseMode": { "description": "User-specified flag to indicate which mode to use for advertisement.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "CUSTOM", "DEFAULT" ] }, "advertisedGroups": { "description": "User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the \"bgp\" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Advertise all available subnets (including peer VPC subnets)." ], "enum": [ "ALL_SUBNETS" ] } }, "advertisedIpRanges": { "description": "User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the \"bgp\" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.", "type": "array", "items": { "$ref": "RouterAdvertisedIpRange" } }, "managementType": { "description": "[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. ", "type": "string", "enumDescriptions": [ "The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create\/delete this BGP peer when the PARTNER InterconnectAttachment is created\/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress.", "Default value, the BGP peer is manually created and managed by user." ], "enum": [ "MANAGED_BY_ATTACHMENT", "MANAGED_BY_USER" ] }, "enable": { "description": "The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "FALSE", "TRUE" ] }, "bfd": { "description": "BFD configuration for the BGP peering.", "$ref": "RouterBgpPeerBfd" }, "routerApplianceInstance": { "description": "URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session.", "type": "string" }, "enableIpv6": { "description": "Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.", "type": "boolean" }, "ipv6NexthopAddress": { "description": "IPv6 address of the interface inside Google Cloud Platform.", "type": "string" }, "peerIpv6NexthopAddress": { "description": "IPv6 address of the BGP interface outside Google Cloud Platform.", "type": "string" }, "md5AuthenticationKeyName": { "description": "Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.", "type": "string" }, "customLearnedRoutePriority": { "description": "The user-defined custom learned route priority for a BGP session. This value is applied to all custom learned route ranges for the session. You can choose a value from `0` to `65335`. If you don't provide a value, Google Cloud assigns a priority of `100` to the ranges.", "type": "integer", "format": "int32" }, "customLearnedIpRanges": { "description": "A list of user-defined custom learned route IP address ranges for a BGP session.", "type": "array", "items": { "$ref": "RouterBgpPeerCustomLearnedIpRange" } }, "enableIpv4": { "description": "Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.", "type": "boolean" }, "ipv4NexthopAddress": { "description": "IPv4 address of the interface inside Google Cloud Platform.", "type": "string" }, "peerIpv4NexthopAddress": { "description": "IPv4 address of the BGP interface outside Google Cloud Platform.", "type": "string" }, "exportPolicies": { "description": "List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type.", "type": "array", "items": { "type": "string" } }, "importPolicies": { "description": "List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type.", "type": "array", "items": { "type": "string" } } } }, "RouterAdvertisedIpRange": { "id": "RouterAdvertisedIpRange", "description": "Description-tagged IP ranges for the router to advertise.", "type": "object", "properties": { "range": { "description": "The IP range to advertise. The value must be a CIDR-formatted string.", "type": "string" }, "description": { "description": "User-specified description for the IP range.", "type": "string" } } }, "RouterBgpPeerBfd": { "id": "RouterBgpPeerBfd", "type": "object", "properties": { "sessionInitializationMode": { "description": "The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "ACTIVE", "DISABLED", "PASSIVE" ] }, "minTransmitInterval": { "description": "The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.", "type": "integer", "format": "uint32" }, "minReceiveInterval": { "description": "The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.", "type": "integer", "format": "uint32" }, "multiplier": { "description": "The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16. The default is 5.", "type": "integer", "format": "uint32" } } }, "RouterBgpPeerCustomLearnedIpRange": { "id": "RouterBgpPeerCustomLearnedIpRange", "type": "object", "properties": { "range": { "description": "The custom learned route IP address range. Must be a valid CIDR-formatted prefix. If an IP address is provided without a subnet mask, it is interpreted as, for IPv4, a `\/32` singular IP address range, and, for IPv6, `\/128`.", "type": "string" } } }, "RouterBgp": { "id": "RouterBgp", "type": "object", "properties": { "asn": { "description": "Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.", "type": "integer", "format": "uint32" }, "advertiseMode": { "description": "User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "CUSTOM", "DEFAULT" ] }, "advertisedGroups": { "description": "User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Advertise all available subnets (including peer VPC subnets)." ], "enum": [ "ALL_SUBNETS" ] } }, "advertisedIpRanges": { "description": "User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.", "type": "array", "items": { "$ref": "RouterAdvertisedIpRange" } }, "keepaliveInterval": { "description": "The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 20 and 60. The default is 20.", "type": "integer", "format": "uint32" }, "identifierRange": { "description": "Explicitly specifies a range of valid BGP Identifiers for this Router. It is provided as a link-local IPv4 range (from 169.254.0.0\/16), of size at least \/30, even if the BGP sessions are over IPv6. It must not overlap with any IPv4 BGP session ranges. Other vendors commonly call this \"router ID\".", "type": "string" } } }, "RouterNat": { "id": "RouterNat", "description": "Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.", "type": "object", "properties": { "name": { "description": "Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "type": { "description": "Indicates whether this NAT is used for public or private IP translation. If unspecified, it defaults to PUBLIC.", "type": "string", "enumDescriptions": [ "NAT used for private IP translation.", "NAT used for public IP translation. This is the default." ], "enum": [ "PRIVATE", "PUBLIC" ] }, "autoNetworkTier": { "description": "The network tier to use when automatically reserving NAT IP addresses. Must be one of: PREMIUM, STANDARD. If not specified, then the current project-level default tier is used.", "type": "string", "enumDescriptions": [ "Public internet quality with fixed bandwidth.", "High quality, Google-grade network tier, support for all networking products.", "Public internet quality, only limited support for other networking products.", "(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured." ], "enum": [ "FIXED_STANDARD", "PREMIUM", "STANDARD", "STANDARD_OVERRIDES_FIXED_STANDARD" ] }, "endpointTypes": { "description": "List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM", "type": "array", "items": { "type": "string", "enumDescriptions": [ "This is used for regional Application Load Balancers (internal and external) and regional proxy Network Load Balancers (internal and external) endpoints.", "This is used for Secure Web Gateway endpoints.", "This is the default." ], "enum": [ "ENDPOINT_TYPE_MANAGED_PROXY_LB", "ENDPOINT_TYPE_SWG", "ENDPOINT_TYPE_VM" ] } }, "sourceSubnetworkIpRangesToNat": { "description": "Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there should not be any other Router.Nat section in any Router for this network in this region.", "type": "string", "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 subnetwork below)" ], "enum": [ "ALL_SUBNETWORKS_ALL_IP_RANGES", "ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES", "LIST_OF_SUBNETWORKS" ] }, "subnetworks": { "description": "A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.", "type": "array", "items": { "$ref": "RouterNatSubnetworkToNat" } }, "natIps": { "description": "A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.", "type": "array", "items": { "type": "string" } }, "drainNatIps": { "description": "A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating\/patching a NAT only.", "type": "array", "items": { "type": "string" } }, "natIpAllocateOption": { "description": "Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. ", "type": "string", "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 enough then the Nat service fails for new VMs." ], "enum": [ "AUTO_ONLY", "MANUAL_ONLY" ] }, "minPortsPerVm": { "description": "Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.", "type": "integer", "format": "int32" }, "maxPortsPerVm": { "description": "Maximum number of ports allocated to a VM from this NAT config when Dynamic Port Allocation is enabled. If Dynamic Port Allocation is not enabled, this field has no effect. If Dynamic Port Allocation is enabled, and this field is set, it must be set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm is not set. If Dynamic Port Allocation is enabled and this field is not set, a maximum of 65536 ports will be allocated to a VM from this NAT config.", "type": "integer", "format": "int32" }, "enableDynamicPortAllocation": { "description": "Enable Dynamic Port Allocation. If not specified, it is disabled by default. If set to true, - Dynamic Port Allocation will be enabled on this NAT config. - enableEndpointIndependentMapping cannot be set to true. - If minPorts is set, minPortsPerVm must be set to a power of two greater than or equal to 32. If minPortsPerVm is not set, a minimum of 32 ports will be allocated to a VM from this NAT config. ", "type": "boolean" }, "udpIdleTimeoutSec": { "description": "Timeout (in seconds) for UDP connections. Defaults to 30s if not set.", "type": "integer", "format": "int32" }, "icmpIdleTimeoutSec": { "description": "Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.", "type": "integer", "format": "int32" }, "tcpEstablishedIdleTimeoutSec": { "description": "Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.", "type": "integer", "format": "int32" }, "tcpTransitoryIdleTimeoutSec": { "description": "Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.", "type": "integer", "format": "int32" }, "tcpTimeWaitTimeoutSec": { "description": "Timeout (in seconds) for TCP connections that are in TIME_WAIT state. Defaults to 120s if not set.", "type": "integer", "format": "int32" }, "logConfig": { "description": "Configure logging on this NAT.", "$ref": "RouterNatLogConfig" }, "rules": { "description": "A list of rules associated with this NAT.", "type": "array", "items": { "$ref": "RouterNatRule" } }, "enableEndpointIndependentMapping": { "type": "boolean" } } }, "RouterNatSubnetworkToNat": { "id": "RouterNatSubnetworkToNat", "description": "Defines the IP ranges that want to use NAT for a subnetwork.", "type": "object", "properties": { "name": { "description": "URL for the subnetwork resource that will use NAT.", "type": "string" }, "sourceIpRangesToNat": { "description": "Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: [\"PRIMARY_IP_RANGE\", \"LIST_OF_SECONDARY_IP_RANGES\"] Default: [ALL_IP_RANGES]", "type": "array", "items": { "type": "string", "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." ], "enum": [ "ALL_IP_RANGES", "LIST_OF_SECONDARY_IP_RANGES", "PRIMARY_IP_RANGE" ] } }, "secondaryIpRangeNames": { "description": "A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if \"LIST_OF_SECONDARY_IP_RANGES\" is one of the values in source_ip_ranges_to_nat.", "type": "array", "items": { "type": "string" } } } }, "RouterNatLogConfig": { "id": "RouterNatLogConfig", "description": "Configuration of logging on a NAT.", "type": "object", "properties": { "enable": { "description": "Indicates whether or not to export logs. This is false by default.", "type": "boolean" }, "filter": { "description": "Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: - ERRORS_ONLY: Export logs only for connection failures. - TRANSLATIONS_ONLY: Export logs only for successful connections. - ALL: Export logs for all connections, successful and unsuccessful. ", "type": "string", "enumDescriptions": [ "Export logs for all (successful and unsuccessful) connections.", "Export logs for connection failures only.", "Export logs for successful connections only." ], "enum": [ "ALL", "ERRORS_ONLY", "TRANSLATIONS_ONLY" ] } } }, "RouterNatRule": { "id": "RouterNatRule", "type": "object", "properties": { "ruleNumber": { "description": "An integer uniquely identifying a rule in the list. The rule number must be a positive value between 0 and 65000, and must be unique among rules within a NAT.", "type": "integer", "format": "uint32" }, "description": { "description": "An optional description of this rule.", "type": "string" }, "match": { "description": "CEL expression that specifies the match condition that egress traffic from a VM is evaluated against. If it evaluates to true, the corresponding `action` is enforced. The following examples are valid match expressions for public NAT: `inIpRange(destination.ip, '1.1.0.0\/16') \|\| inIpRange(destination.ip, '2.2.0.0\/16')` `destination.ip == '1.1.0.1' \|\| destination.ip == '8.8.8.8'` The following example is a valid match expression for private NAT: `nexthop.hub == '\/\/networkconnectivity.googleapis.com\/projects\/my-project\/locations\/global\/hubs\/hub-1'`", "type": "string" }, "action": { "description": "The action to be enforced for traffic that matches this rule.", "$ref": "RouterNatRuleAction" } } }, "RouterNatRuleAction": { "id": "RouterNatRuleAction", "type": "object", "properties": { "sourceNatActiveIps": { "description": "A list of URLs of the IP resources used for this NAT rule. These IP addresses must be valid static external IP addresses assigned to the project. This field is used for public NAT.", "type": "array", "items": { "type": "string" } }, "sourceNatDrainIps": { "description": "A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating\/patching a NAT rule only. This field is used for public NAT.", "type": "array", "items": { "type": "string" } }, "sourceNatActiveRanges": { "description": "A list of URLs of the subnetworks used as source ranges for this NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. This field is used for private NAT.", "type": "array", "items": { "type": "string" } }, "sourceNatDrainRanges": { "description": "A list of URLs of subnetworks representing source ranges to be drained. This is only supported on patch\/update, and these subnetworks must have previously been used as active ranges in this NAT Rule. This field is used for private NAT.", "type": "array", "items": { "type": "string" } } } }, "RouterMd5AuthenticationKey": { "id": "RouterMd5AuthenticationKey", "type": "object", "properties": { "name": { "description": "Name used to identify the key. Must be unique within a router. Must be referenced by exactly one bgpPeer. Must comply with RFC1035.", "annotations": { "required": [ "compute.routers.insert", "compute.routers.update" ] }, "type": "string" }, "key": { "description": "[Input only] Value of the key. For patch and update calls, it can be skipped to copy the value from the previous configuration. This is allowed if the key with the same name existed before the operation. Maximum length is 80 characters. Can only contain printable ASCII characters.", "annotations": { "required": [ "compute.routers.insert" ] }, "type": "string" } } }, "RouterList": { "id": "RouterList", "description": "Contains a list of Router resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#router for routers.", "default": "compute#routerList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Router resources.", "type": "array", "items": { "$ref": "Router" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "RouterAggregatedList": { "id": "RouterAggregatedList", "description": "Contains a list of routers.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#routerAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Router resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of routers.", "$ref": "RoutersScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "RoutersScopedList": { "id": "RoutersScopedList", "type": "object", "properties": { "routers": { "description": "A list of routers contained in this scope.", "type": "array", "items": { "$ref": "Router" } }, "warning": { "description": "Informational warning which replaces the list of routers when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "RouterStatusResponse": { "id": "RouterStatusResponse", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#routerStatusResponse", "type": "string" }, "result": { "$ref": "RouterStatus" } } }, "RouterStatus": { "id": "RouterStatus", "type": "object", "properties": { "network": { "description": "URI of the network to which this router belongs.", "type": "string" }, "bestRoutes": { "description": "A list of the best dynamic routes for this Cloud Router's Virtual Private Cloud (VPC) network in the same region as this Cloud Router. Lists all of the best routes per prefix that are programmed into this region's VPC data plane. When global dynamic routing mode is turned on in the VPC network, this list can include cross-region dynamic routes from Cloud Routers in other regions.", "type": "array", "items": { "$ref": "Route" } }, "bestRoutesForRouter": { "description": "A list of the best BGP routes learned by this Cloud Router. It is possible that routes listed might not be programmed into the data plane, if the Google Cloud control plane finds a more optimal route for a prefix than a route learned by this Cloud Router.", "type": "array", "items": { "$ref": "Route" } }, "bgpPeerStatus": { "type": "array", "items": { "$ref": "RouterStatusBgpPeerStatus" } }, "natStatus": { "type": "array", "items": { "$ref": "RouterStatusNatStatus" } } } }, "RouterStatusBgpPeerStatus": { "id": "RouterStatusBgpPeerStatus", "type": "object", "properties": { "name": { "description": "Name of this BGP peer. Unique within the Routers resource.", "type": "string" }, "linkedVpnTunnel": { "description": "URL of the VPN tunnel that this BGP peer controls.", "type": "string" }, "routerApplianceInstance": { "description": "[Output only] URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance is the peer side of the BGP session.", "type": "string" }, "ipAddress": { "description": "IP address of the local BGP interface.", "type": "string" }, "peerIpAddress": { "description": "IP address of the remote BGP interface.", "type": "string" }, "ipv6NexthopAddress": { "description": "IPv6 address of the local BGP interface.", "type": "string" }, "peerIpv6NexthopAddress": { "description": "IPv6 address of the remote BGP interface.", "type": "string" }, "enableIpv6": { "description": "Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.", "type": "boolean" }, "status": { "description": "Status of the BGP peer: {UP, DOWN}", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "DOWN", "UNKNOWN", "UP" ] }, "state": { "description": "The state of the BGP session. For a list of possible values for this field, see BGP session states.", "type": "string" }, "uptime": { "description": "Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds", "type": "string" }, "uptimeSeconds": { "description": "Time this session has been up, in seconds. Format: 145", "type": "string" }, "numLearnedRoutes": { "description": "Number of routes learned from the remote BGP Peer.", "type": "integer", "format": "uint32" }, "advertisedRoutes": { "description": "Routes that were advertised to the remote BGP peer", "type": "array", "items": { "$ref": "Route" } }, "bfdStatus": { "$ref": "BfdStatus" }, "md5AuthEnabled": { "description": "Informs whether MD5 authentication is enabled on this BGP peer.", "type": "boolean" }, "statusReason": { "description": "Indicates why particular status was returned.", "type": "string", "enumDescriptions": [ "BGP peer disabled because it requires IPv4 but the underlying connection is IPv6-only.", "BGP peer disabled because it requires IPv6 but the underlying connection is IPv4-only.", "Indicates internal problems with configuration of MD5 authentication. This particular reason can only be returned when md5AuthEnabled is true and status is DOWN.", "" ], "enum": [ "IPV4_PEER_ON_IPV6_ONLY_CONNECTION", "IPV6_PEER_ON_IPV4_ONLY_CONNECTION", "MD5_AUTH_INTERNAL_PROBLEM", "STATUS_REASON_UNSPECIFIED" ] }, "ipv4NexthopAddress": { "description": "IPv4 address of the local BGP interface.", "type": "string" }, "peerIpv4NexthopAddress": { "description": "IPv4 address of the remote BGP interface.", "type": "string" }, "enableIpv4": { "description": "Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.", "type": "boolean" } } }, "BfdStatus": { "id": "BfdStatus", "description": "Next free: 15", "type": "object", "properties": { "uptimeMs": { "description": "Session uptime in milliseconds. Value will be 0 if session is not up.", "type": "string", "format": "int64" }, "localState": { "description": "The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880", "type": "string", "enumDescriptions": [ "", "", "", "", "" ], "enum": [ "ADMIN_DOWN", "DOWN", "INIT", "STATE_UNSPECIFIED", "UP" ] }, "localDiagnostic": { "description": "The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880", "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "" ], "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" ] }, "controlPacketCounts": { "description": "Control packet counts for the current BFD session.", "$ref": "BfdStatusPacketCounts" }, "txPacket": { "description": "The most recent Tx control packet for this BFD session.", "$ref": "BfdPacket" }, "rxPacket": { "description": "The most recent Rx control packet for this BFD session.", "$ref": "BfdPacket" }, "controlPacketIntervals": { "description": "Inter-packet time interval statistics for control packets.", "type": "array", "items": { "$ref": "PacketIntervals" } }, "negotiatedLocalControlTxIntervalMs": { "description": "Negotiated transmit interval for control packets.", "type": "integer", "format": "uint32" }, "bfdSessionInitializationMode": { "description": "The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "ACTIVE", "DISABLED", "PASSIVE" ] }, "configUpdateTimestampMicros": { "description": "Unix timestamp of the most recent config update.", "type": "string", "format": "int64" } } }, "BfdStatusPacketCounts": { "id": "BfdStatusPacketCounts", "type": "object", "properties": { "numTx": { "description": "Number of packets transmitted since the beginning of the current BFD session.", "type": "integer", "format": "uint32" }, "numRx": { "description": "Number of packets received since the beginning of the current BFD session.", "type": "integer", "format": "uint32" }, "numRxSuccessful": { "description": "Number of packets received that were successfully processed since the beginning of the current BFD session.", "type": "integer", "format": "uint32" }, "numRxRejected": { "description": "Number of packets received that were rejected because of errors since the beginning of the current BFD session.", "type": "integer", "format": "uint32" } } }, "BfdPacket": { "id": "BfdPacket", "type": "object", "properties": { "version": { "description": "The version number of the BFD protocol, as specified in section 4.1 of RFC5880.", "type": "integer", "format": "uint32" }, "diagnostic": { "description": "The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880", "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "", "", "" ], "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" ] }, "state": { "description": "The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880", "type": "string", "enumDescriptions": [ "", "", "", "", "" ], "enum": [ "ADMIN_DOWN", "DOWN", "INIT", "STATE_UNSPECIFIED", "UP" ] }, "poll": { "description": "The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880", "type": "boolean" }, "final": { "description": "The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880", "type": "boolean" }, "controlPlaneIndependent": { "description": "The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880", "type": "boolean" }, "authenticationPresent": { "description": "The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880", "type": "boolean" }, "demand": { "description": "The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880", "type": "boolean" }, "multipoint": { "description": "The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880", "type": "boolean" }, "multiplier": { "description": "The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880", "type": "integer", "format": "uint32" }, "length": { "description": "The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880", "type": "integer", "format": "uint32" }, "myDiscriminator": { "description": "The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880", "type": "integer", "format": "uint32" }, "yourDiscriminator": { "description": "The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880", "type": "integer", "format": "uint32" }, "minTxIntervalMs": { "description": "The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880", "type": "integer", "format": "uint32" }, "minRxIntervalMs": { "description": "The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880", "type": "integer", "format": "uint32" }, "minEchoRxIntervalMs": { "description": "The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880", "type": "integer", "format": "uint32" } } }, "PacketIntervals": { "id": "PacketIntervals", "description": "Next free: 7", "type": "object", "properties": { "type": { "description": "The type of packets for which inter-packet intervals were computed.", "type": "string", "enumDescriptions": [ "Only applies to Echo packets. This shows the intervals between sending and receiving the same packet.", "Intervals between received packets.", "Intervals between transmitted packets.", "" ], "enum": [ "LOOPBACK", "RECEIVE", "TRANSMIT", "TYPE_UNSPECIFIED" ] }, "duration": { "description": "From how long ago in the past these intervals were observed.", "type": "string", "enumDescriptions": [ "", "", "From BfdSession object creation time.", "" ], "enum": [ "DURATION_UNSPECIFIED", "HOUR", "MAX", "MINUTE" ] }, "numIntervals": { "description": "Number of inter-packet intervals from which these statistics were derived.", "type": "string", "format": "int64" }, "minMs": { "description": "Minimum observed inter-packet interval in milliseconds.", "type": "string", "format": "int64" }, "maxMs": { "description": "Maximum observed inter-packet interval in milliseconds.", "type": "string", "format": "int64" }, "avgMs": { "description": "Average observed inter-packet interval in milliseconds.", "type": "string", "format": "int64" } } }, "RouterStatusNatStatus": { "id": "RouterStatusNatStatus", "description": "Status of a NAT contained in this router.", "type": "object", "properties": { "name": { "description": "Unique name of this NAT.", "type": "string" }, "userAllocatedNatIpResources": { "description": "A list of fully qualified URLs of reserved IP address resources.", "type": "array", "items": { "type": "string" } }, "drainUserAllocatedNatIps": { "description": "A list of IPs user-allocated for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].", "type": "array", "items": { "type": "string" } }, "userAllocatedNatIps": { "description": "A list of IPs user-allocated for NAT. They will be raw IP strings like \"179.12.26.133\".", "type": "array", "items": { "type": "string" } }, "autoAllocatedNatIps": { "description": "A list of IPs auto-allocated for NAT. Example: [\"1.1.1.1\", \"129.2.16.89\"]", "type": "array", "items": { "type": "string" } }, "drainAutoAllocatedNatIps": { "description": "A list of IPs auto-allocated for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].", "type": "array", "items": { "type": "string" } }, "minExtraNatIpsNeeded": { "description": "The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is not* used.", "type": "integer", "format": "int32" }, "numVmEndpointsWithNatMappings": { "description": "Number of VM endpoints (i.e., Nics) that can use NAT.", "type": "integer", "format": "int32" }, "ruleStatus": { "description": "Status of rules in this NAT.", "type": "array", "items": { "$ref": "RouterStatusNatStatusNatRuleStatus" } } } }, "RouterStatusNatStatusNatRuleStatus": { "id": "RouterStatusNatStatusNatRuleStatus", "description": "Status of a NAT Rule contained in this NAT.", "type": "object", "properties": { "ruleNumber": { "description": "Rule number of the rule.", "type": "integer", "format": "int32" }, "activeNatIps": { "description": "A list of active IPs for NAT. Example: [\"1.1.1.1\", \"179.12.26.133\"].", "type": "array", "items": { "type": "string" } }, "drainNatIps": { "description": "A list of IPs for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].", "type": "array", "items": { "type": "string" } }, "minExtraIpsNeeded": { "description": "The number of extra IPs to allocate. This will be greater than 0 only if the existing IPs in this NAT Rule are NOT enough to allow all configured VMs to use NAT.", "type": "integer", "format": "int32" }, "numVmEndpointsWithNatMappings": { "description": "Number of VM endpoints (i.e., NICs) that have NAT Mappings from this NAT Rule.", "type": "integer", "format": "int32" } } }, "VmEndpointNatMappingsList": { "id": "VmEndpointNatMappingsList", "description": "Contains a list of VmEndpointNatMappings.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints.", "default": "compute#vmEndpointNatMappingsList", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string" }, "result": { "description": "[Output Only] A list of Nat mapping information of VM endpoints.", "type": "array", "items": { "$ref": "VmEndpointNatMappings" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "VmEndpointNatMappings": { "id": "VmEndpointNatMappings", "description": "Contain information of Nat mapping for a VM endpoint (i.e., NIC).", "type": "object", "properties": { "instanceName": { "description": "Name of the VM instance which the endpoint belongs to", "type": "string" }, "interfaceNatMappings": { "type": "array", "items": { "$ref": "VmEndpointNatMappingsInterfaceNatMappings" } } } }, "VmEndpointNatMappingsInterfaceNatMappings": { "id": "VmEndpointNatMappingsInterfaceNatMappings", "description": "Contain information of Nat mapping for an interface of this endpoint.", "type": "object", "properties": { "sourceVirtualIp": { "description": "Primary IP of the VM for this NIC.", "type": "string" }, "sourceAliasIpRange": { "description": "Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: \"10.33.4.55\/32\", or \"192.168.5.0\/24\".", "type": "string" }, "numTotalNatPorts": { "description": "Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges.", "type": "integer", "format": "int32" }, "natIpPortRanges": { "description": "A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"].", "type": "array", "items": { "type": "string" } }, "drainNatIpPortRanges": { "description": "List of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"].", "type": "array", "items": { "type": "string" } }, "numTotalDrainNatPorts": { "description": "Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges.", "type": "integer", "format": "int32" }, "ruleMappings": { "description": "Information about mappings provided by rules in this NAT.", "type": "array", "items": { "$ref": "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings" } } } }, "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings": { "id": "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings", "description": "Contains information of NAT Mappings provided by a NAT Rule.", "type": "object", "properties": { "ruleNumber": { "description": "Rule number of the NAT Rule.", "type": "integer", "format": "int32" }, "numTotalNatPorts": { "description": "Total number of ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field nat_ip_port_ranges.", "type": "integer", "format": "int32" }, "natIpPortRanges": { "description": "A list of all IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"].", "type": "array", "items": { "type": "string" } }, "drainNatIpPortRanges": { "description": "List of all drain IP:port-range mappings assigned to this interface by this rule. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"].", "type": "array", "items": { "type": "string" } }, "numTotalDrainNatPorts": { "description": "Total number of drain ports across all NAT IPs allocated to this interface by this rule. It equals the aggregated port number in the field drain_nat_ip_port_ranges.", "type": "integer", "format": "int32" } } }, "NatIpInfoResponse": { "id": "NatIpInfoResponse", "type": "object", "properties": { "result": { "description": "[Output Only] A list of NAT IP information.", "type": "array", "items": { "$ref": "NatIpInfo" } } } }, "NatIpInfo": { "id": "NatIpInfo", "description": "Contains NAT IP information of a NAT config (i.e. usage status, mode).", "type": "object", "properties": { "natName": { "description": "Name of the NAT config which the NAT IP belongs to.", "type": "string" }, "natIpInfoMappings": { "description": "A list of all NAT IPs assigned to this NAT config.", "type": "array", "items": { "$ref": "NatIpInfoNatIpInfoMapping" } } } }, "NatIpInfoNatIpInfoMapping": { "id": "NatIpInfoNatIpInfoMapping", "description": "Contains information of a NAT IP.", "type": "object", "properties": { "natIp": { "description": "NAT IP address. For example: 203.0.113.11.", "type": "string" }, "usage": { "description": "Specifies whether NAT IP is currently serving at least one endpoint or not.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "IN_USE", "UNUSED" ] }, "mode": { "description": "Specifies whether NAT IP is auto or manual.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "AUTO", "MANUAL" ] } } }, "RoutersPreviewResponse": { "id": "RoutersPreviewResponse", "type": "object", "properties": { "resource": { "description": "Preview of given router.", "$ref": "Router" } } }, "RoutePolicy": { "id": "RoutePolicy", "type": "object", "properties": { "name": { "description": "Route Policy name, which must be a resource ID segment and unique within all the router's Route Policies. Name should conform to RFC1035.", "type": "string" }, "type": { "type": "string", "enumDescriptions": [ "The Route Policy is an Export Policy.", "The Route Policy is an Import Policy." ], "enum": [ "ROUTE_POLICY_TYPE_EXPORT", "ROUTE_POLICY_TYPE_IMPORT" ] }, "terms": { "description": "List of terms (the order in the list is not important, they are evaluated in order of priority). Order of policies is not retained and might change when getting policy later.", "type": "array", "items": { "$ref": "RoutePolicyPolicyTerm" } }, "fingerprint": { "description": "A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.", "type": "string", "format": "byte" }, "description": { "description": "An optional description of route policy.", "type": "string" } } }, "RoutePolicyPolicyTerm": { "id": "RoutePolicyPolicyTerm", "type": "object", "properties": { "priority": { "description": "The evaluation priority for this term, which must be between 0 (inclusive) and 2^31 (exclusive), and unique within the list.", "type": "integer", "format": "int32" }, "match": { "description": "CEL expression evaluated against a route to determine if this term applies. When not set, the term applies to all routes.", "$ref": "Expr" }, "actions": { "description": "CEL expressions to evaluate to modify a route when this term matches.", "type": "array", "items": { "$ref": "Expr" } } } }, "RoutersGetRoutePolicyResponse": { "id": "RoutersGetRoutePolicyResponse", "type": "object", "properties": { "resource": { "$ref": "RoutePolicy" } } }, "RoutersListRoutePolicies": { "id": "RoutersListRoutePolicies", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#routersListRoutePolicies for lists of route policies.", "default": "compute#routersListRoutePolicies", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string" }, "result": { "description": "[Output Only] A list of route policies.", "type": "array", "items": { "$ref": "RoutePolicy" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "etag": { "type": "string" }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "RoutersListBgpRoutes": { "id": "RoutersListBgpRoutes", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#routersListBgpRoutes for lists of bgp routes.", "default": "compute#routersListBgpRoutes", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string" }, "result": { "description": "[Output Only] A list of bgp routes.", "type": "array", "items": { "$ref": "BgpRoute" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "etag": { "type": "string" }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "BgpRoute": { "id": "BgpRoute", "type": "object", "properties": { "destination": { "description": "[Output only] Destination IP range for the route, in human-readable CIDR format", "$ref": "BgpRouteNetworkLayerReachabilityInformation" }, "asPaths": { "description": "[Output only] AS-PATH for the route", "type": "array", "items": { "$ref": "BgpRouteAsPath" } }, "communities": { "description": "[Output only] BGP communities in human-readable A:B format.", "type": "array", "items": { "type": "string" } }, "origin": { "description": "[Output only] BGP origin (EGP, IGP or INCOMPLETE)", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "BGP_ORIGIN_EGP", "BGP_ORIGIN_IGP", "BGP_ORIGIN_INCOMPLETE" ] }, "med": { "description": "[Output only] BGP multi-exit discriminator", "type": "integer", "format": "uint32" } } }, "BgpRouteNetworkLayerReachabilityInformation": { "id": "BgpRouteNetworkLayerReachabilityInformation", "description": "Network Layer Reachability Information (NLRI) for a route.", "type": "object", "properties": { "prefix": { "description": "Human readable CIDR notation for a prefix. E.g. 10.42.0.0\/16.", "type": "string" }, "pathId": { "description": "If the BGP session supports multiple paths (RFC 7911), the path identifier for this route.", "type": "integer", "format": "uint32" } } }, "BgpRouteAsPath": { "id": "BgpRouteAsPath", "type": "object", "properties": { "type": { "description": "[Output only] Type of AS-PATH segment (SEQUENCE or SET)", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "AS_PATH_TYPE_SEQUENCE", "AS_PATH_TYPE_SET" ] }, "asns": { "description": "[Output only] ASNs in the path segment. When type is SEQUENCE, these are ordered.", "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "ServiceAttachmentAggregatedList": { "id": "ServiceAttachmentAggregatedList", "description": "Contains a list of ServiceAttachmentsScopedList.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#serviceAttachmentAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of ServiceAttachmentsScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of ServiceAttachments.", "$ref": "ServiceAttachmentsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "ServiceAttachmentsScopedList": { "id": "ServiceAttachmentsScopedList", "type": "object", "properties": { "serviceAttachments": { "description": "A list of ServiceAttachments contained in this scope.", "type": "array", "items": { "$ref": "ServiceAttachment" } }, "warning": { "description": "Informational warning which replaces the list of service attachments when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "ServiceAttachment": { "id": "ServiceAttachment", "description": "Represents a ServiceAttachment resource. A service attachment represents a service that a producer has exposed. It encapsulates the load balancer which fronts the service runs and a list of NAT IP ranges that the producers uses to represent the consumers connecting to the service.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.", "default": "compute#serviceAttachment", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.serviceAttachments.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "producerForwardingRule": { "description": "The URL of a forwarding rule with loadBalancingScheme INTERNAL that is serving the endpoint identified by this service attachment.", "deprecated": true, "type": "string" }, "targetService": { "description": "The URL of a service serving the endpoint identified by this service attachment.", "type": "string" }, "connectionPreference": { "description": "The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules.", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "ACCEPT_AUTOMATIC", "ACCEPT_MANUAL", "CONNECTION_PREFERENCE_UNSPECIFIED" ] }, "connectedEndpoints": { "description": "[Output Only] An array of connections for all the consumers connected to this service attachment.", "type": "array", "items": { "$ref": "ServiceAttachmentConnectedEndpoint" } }, "natSubnets": { "description": "An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.", "type": "array", "items": { "type": "string" } }, "enableProxyProtocol": { "description": "If true, enable the proxy protocol which is for supplying client TCP\/IP address data in TCP connections that traverse proxies on their way to destination servers.", "type": "boolean" }, "consumerRejectLists": { "description": "Specifies a list of projects or networks that are not allowed to connect to this service attachment. The project can be specified using its project ID or project number and the network can be specified using its URL. A given service attachment can manage connections at either the project or network level. Therefore, both the reject and accept lists for a given service attachment must contain either only projects or only networks.", "type": "array", "items": { "type": "string" } }, "consumerAcceptLists": { "description": "Specifies which consumer projects or networks are allowed to connect to the service attachment. Each project or network has a connection limit. A given service attachment can manage connections at either the project or network level. Therefore, both the accept and reject lists for a given service attachment must contain either only projects or only networks.", "type": "array", "items": { "$ref": "ServiceAttachmentConsumerProjectLimit" } }, "pscServiceAttachmentId": { "description": "[Output Only] An 128-bit global unique ID of the PSC service attachment.", "$ref": "Uint128" }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch\/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.", "type": "string", "format": "byte" }, "domainNames": { "description": "If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: \"p.mycompany.com.\". Current max number of domain names supported is 1.", "type": "array", "items": { "type": "string" } }, "reconcileConnections": { "description": "This flag determines whether a consumer accept\/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED\/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED\/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to false.", "type": "boolean" }, "propagatedConnectionLimit": { "description": "The number of consumer spokes that connected Private Service Connect endpoints can be propagated to through Network Connectivity Center. This limit lets the service producer limit how many propagated Private Service Connect connections can be established to this service attachment from a single consumer. If the connection preference of the service attachment is ACCEPT_MANUAL, the limit applies to each project or network that is listed in the consumer accept list. If the connection preference of the service attachment is ACCEPT_AUTOMATIC, the limit applies to each project that contains a connected endpoint. If unspecified, the default propagated connection limit is 250.", "type": "integer", "format": "uint32" } } }, "ServiceAttachmentConnectedEndpoint": { "id": "ServiceAttachmentConnectedEndpoint", "description": "[Output Only] A connection connected to this service attachment.", "type": "object", "properties": { "status": { "description": "The status of a connected endpoint to this service attachment.", "type": "string", "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 needs to take further action before the forwarding rule can serve traffic.", "The connection is pending acceptance by the producer.", "The consumer is still connected but not using the connection.", "" ], "enum": [ "ACCEPTED", "CLOSED", "NEEDS_ATTENTION", "PENDING", "REJECTED", "STATUS_UNSPECIFIED" ] }, "pscConnectionId": { "description": "The PSC connection id of the connected endpoint.", "type": "string", "format": "uint64" }, "endpoint": { "description": "The url of a connected endpoint.", "type": "string" }, "consumerNetwork": { "description": "The url of the consumer network.", "type": "string" }, "propagatedConnectionCount": { "description": "The number of consumer Network Connectivity Center spokes that the connected Private Service Connect endpoint has propagated to.", "type": "integer", "format": "uint32" } } }, "ServiceAttachmentConsumerProjectLimit": { "id": "ServiceAttachmentConsumerProjectLimit", "type": "object", "properties": { "projectIdOrNum": { "description": "The project id or number for the project to set the limit for.", "type": "string" }, "networkUrl": { "description": "The network URL for the network to set the limit for.", "type": "string" }, "connectionLimit": { "description": "The value of the limit to set.", "type": "integer", "format": "uint32" } } }, "Uint128": { "id": "Uint128", "type": "object", "properties": { "high": { "type": "string", "format": "uint64" }, "low": { "type": "string", "format": "uint64" } } }, "ServiceAttachmentList": { "id": "ServiceAttachmentList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.", "default": "compute#serviceAttachmentList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of ServiceAttachment resources.", "type": "array", "items": { "$ref": "ServiceAttachment" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "SnapshotSettings": { "id": "SnapshotSettings", "type": "object", "properties": { "storageLocation": { "description": "Policy of which storage location is going to be resolved, and additional data that particularizes how the policy is going to be carried out.", "$ref": "SnapshotSettingsStorageLocationSettings" } } }, "SnapshotSettingsStorageLocationSettings": { "id": "SnapshotSettingsStorageLocationSettings", "type": "object", "properties": { "policy": { "description": "The chosen location policy.", "type": "string", "enumDescriptions": [ "Store snapshot in the same region as with the originating disk. No additional parameters are needed.", "Store snapshot in the nearest multi region Cloud Storage bucket, relative to the originating disk. No additional parameters are needed.", "Store snapshot in the specific locations, as specified by the user. The list of regions to store must be defined under the `locations` field.", "" ], "enum": [ "LOCAL_REGION", "NEAREST_MULTI_REGION", "SPECIFIC_LOCATIONS", "STORAGE_LOCATION_POLICY_UNSPECIFIED" ] }, "locations": { "description": "When the policy is SPECIFIC_LOCATIONS, snapshots will be stored in the locations listed in this field. Keys are Cloud Storage bucket locations. Only one location can be specified.", "type": "object", "additionalProperties": { "$ref": "SnapshotSettingsStorageLocationSettingsStorageLocationPreference" } } } }, "SnapshotSettingsStorageLocationSettingsStorageLocationPreference": { "id": "SnapshotSettingsStorageLocationSettingsStorageLocationPreference", "description": "A structure for specifying storage locations.", "type": "object", "properties": { "name": { "description": "Name of the location. It should be one of the Cloud Storage buckets. Only one location can be specified.", "type": "string" } } }, "SslCertificateList": { "id": "SslCertificateList", "description": "Contains a list of SslCertificate resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#sslCertificateList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of SslCertificate resources.", "type": "array", "items": { "$ref": "SslCertificate" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "SslCertificate": { "id": "SslCertificate", "description": "Represents an SSL certificate resource. Google Compute Engine has two SSL certificate resources: * [Global](\/compute\/docs\/reference\/rest\/v2\/sslCertificates) * [Regional](\/compute\/docs\/reference\/rest\/v2\/regionSslCertificates) The global SSL certificates (sslCertificates) are used by: - Global external Application Load Balancers - Classic Application Load Balancers - Proxy Network Load Balancers (with target SSL proxies) The regional SSL certificates (regionSslCertificates) are used by: - Regional external Application Load Balancers - Regional internal Application Load Balancers Optionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates, SSL certificates quotas and limits, and Troubleshooting SSL certificates.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.", "default": "compute#sslCertificate", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output only] Server-defined URL for the resource.", "type": "string" }, "certificate": { "description": "A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.", "type": "string" }, "privateKey": { "description": "A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field.", "type": "string" }, "managed": { "description": "Configuration and status of a managed SSL certificate.", "$ref": "SslCertificateManagedSslCertificate" }, "selfManaged": { "description": "Configuration and status of a self-managed SSL certificate.", "$ref": "SslCertificateSelfManagedSslCertificate" }, "type": { "description": "(Optional) Specifies the type of SSL certificate, either \"SELF_MANAGED\" or \"MANAGED\". If not specified, the certificate is self-managed and the fields certificate and private_key are used.", "type": "string", "enumDescriptions": [ "Google-managed SSLCertificate.", "Certificate uploaded by user.", "" ], "enum": [ "MANAGED", "SELF_MANAGED", "TYPE_UNSPECIFIED" ] }, "subjectAlternativeNames": { "description": "[Output Only] Domains associated with the certificate via Subject Alternative Name.", "type": "array", "items": { "type": "string" } }, "expireTime": { "description": "[Output Only] Expire time of the certificate. RFC3339", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.", "type": "string" } } }, "SslCertificateManagedSslCertificate": { "id": "SslCertificateManagedSslCertificate", "description": "Configuration and status of a managed SSL certificate.", "type": "object", "properties": { "domains": { "description": "The domains for which a managed SSL certificate will be generated. Each Google-managed SSL certificate supports up to the [maximum number of domains per Google-managed SSL certificate](\/load-balancing\/docs\/quotas#ssl_certificates).", "type": "array", "items": { "type": "string" } }, "status": { "description": "[Output only] Status of the managed certificate resource.", "type": "string", "enumDescriptions": [ "The certificate management is working, and a certificate has been provisioned.", "", "The certificate management is working. GCP will attempt to provision the first certificate.", "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. For details of which domain failed, consult domain_status field.", "Certificate provisioning failed due to an issue with the DNS or load balancing configuration. It won't be retried. To try again delete and create a new managed SslCertificate resource. For details of which domain failed, consult domain_status field.", "Renewal of the certificate has failed due to an issue with the DNS or load balancing configuration. The existing cert is still serving; however, it will expire shortly. To provision a renewed certificate, delete and create a new managed SslCertificate resource. For details on which domain failed, consult domain_status field." ], "enum": [ "ACTIVE", "MANAGED_CERTIFICATE_STATUS_UNSPECIFIED", "PROVISIONING", "PROVISIONING_FAILED", "PROVISIONING_FAILED_PERMANENTLY", "RENEWAL_FAILED" ] }, "domainStatus": { "description": "[Output only] Detailed statuses of the domains specified for managed certificate resource.", "type": "object", "additionalProperties": { "type": "string", "enumDescriptions": [ ], "enum": [ ] } } } }, "SslCertificateSelfManagedSslCertificate": { "id": "SslCertificateSelfManagedSslCertificate", "description": "Configuration and status of a self-managed SSL certificate.", "type": "object", "properties": { "certificate": { "description": "A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.", "type": "string" }, "privateKey": { "description": "A write-only private key in PEM format. Only insert requests will include this field.", "type": "string" } } }, "SslCertificateAggregatedList": { "id": "SslCertificateAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.", "default": "compute#sslCertificateAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of SslCertificatesScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of SslCertificates.", "$ref": "SslCertificatesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "SslCertificatesScopedList": { "id": "SslCertificatesScopedList", "type": "object", "properties": { "sslCertificates": { "description": "List of SslCertificates contained in this scope.", "type": "array", "items": { "$ref": "SslCertificate" } }, "warning": { "description": "Informational warning which replaces the list of backend services when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "SslPoliciesList": { "id": "SslPoliciesList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies.", "default": "compute#sslPoliciesList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of SslPolicy resources.", "type": "array", "items": { "$ref": "SslPolicy" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "SslPolicy": { "id": "SslPolicy", "description": "Represents an SSL Policy resource. Use SSL policies to control SSL features, such as versions and cipher suites, that are offered by Application Load Balancers and proxy Network Load Balancers. For more information, read SSL policies overview.", "type": "object", "properties": { "kind": { "description": "[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.", "default": "compute#sslPolicy", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "name": { "description": "Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "profile": { "description": "Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.", "type": "string", "enumDescriptions": [ "Compatible profile. Allows the broadset set of clients, even those which support only out-of-date SSL features to negotiate with the load balancer.", "Custom profile. Allow only the set of allowed SSL features specified in the customFeatures field.", "Modern profile. Supports a wide set of SSL features, allowing modern clients to negotiate SSL with the load balancer.", "Restricted profile. Supports a reduced set of SSL features, intended to meet stricter compliance requirements." ], "enum": [ "COMPATIBLE", "CUSTOM", "MODERN", "RESTRICTED" ] }, "minTlsVersion": { "description": "The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.", "type": "string", "enumDescriptions": [ "TLS 1.0", "TLS 1.1", "TLS 1.2" ], "enum": [ "TLS_1_0", "TLS_1_1", "TLS_1_2" ] }, "enabledFeatures": { "description": "[Output Only] The list of features enabled in the SSL policy.", "type": "array", "items": { "type": "string" } }, "customFeatures": { "description": "A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.", "type": "array", "items": { "type": "string" } }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.", "type": "string", "format": "byte" }, "warnings": { "description": "[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.", "type": "array", "items": { "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } }, "region": { "description": "[Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies.", "type": "string" } } }, "SslPoliciesListAvailableFeaturesResponse": { "id": "SslPoliciesListAvailableFeaturesResponse", "type": "object", "properties": { "features": { "type": "array", "items": { "type": "string" } } } }, "SslPoliciesAggregatedList": { "id": "SslPoliciesAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#sslPolicyAggregatedList for lists of SSL Policies.", "default": "compute#sslPoliciesAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of SslPoliciesScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of SSL policies.", "$ref": "SslPoliciesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "etag": { "type": "string" }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "SslPoliciesScopedList": { "id": "SslPoliciesScopedList", "type": "object", "properties": { "sslPolicies": { "description": "A list of SslPolicies contained in this scope.", "type": "array", "items": { "$ref": "SslPolicy" } }, "warning": { "description": "Informational warning which replaces the list of SSL policies when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "StoragePoolTypeList": { "id": "StoragePoolTypeList", "description": "Contains a list of storage pool types.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#storagePoolTypeList for storage pool types.", "default": "compute#storagePoolTypeList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of StoragePoolType resources.", "type": "array", "items": { "$ref": "StoragePoolType" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "StoragePoolType": { "id": "StoragePoolType", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#storagePoolType for storage pool types.", "default": "compute#storagePoolType", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "[Output Only] Name of the resource.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "[Output Only] An optional description of this resource.", "type": "string" }, "deprecated": { "description": "[Output Only] The deprecation status associated with this storage pool type.", "$ref": "DeprecationStatus" }, "zone": { "description": "[Output Only] URL of the zone where the storage pool type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" }, "minSizeGb": { "description": "[Deprecated] This field is deprecated. Use minPoolProvisionedCapacityGb instead.", "type": "string", "format": "int64" }, "minPoolProvisionedCapacityGb": { "description": "[Output Only] Minimum storage pool size in GB.", "type": "string", "format": "int64" }, "maxPoolProvisionedCapacityGb": { "description": "[Output Only] Maximum storage pool size in GB.", "type": "string", "format": "int64" }, "minPoolProvisionedIops": { "description": "[Output Only] Minimum provisioned IOPS.", "type": "string", "format": "int64" }, "maxPoolProvisionedIops": { "description": "[Output Only] Maximum provisioned IOPS.", "type": "string", "format": "int64" }, "minPoolProvisionedThroughput": { "description": "[Output Only] Minimum provisioned throughput.", "type": "string", "format": "int64" }, "maxPoolProvisionedThroughput": { "description": "[Output Only] Maximum provisioned throughput.", "type": "string", "format": "int64" }, "supportedDiskTypes": { "description": "[Output Only] The list of disk types supported in this storage pool type.", "type": "array", "items": { "type": "string" } } } }, "StoragePoolTypeAggregatedList": { "id": "StoragePoolTypeAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#storagePoolTypeAggregatedList .", "default": "compute#storagePoolTypeAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of StoragePoolTypesScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of storage pool types.", "$ref": "StoragePoolTypesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "StoragePoolTypesScopedList": { "id": "StoragePoolTypesScopedList", "type": "object", "properties": { "storagePoolTypes": { "description": "[Output Only] A list of storage pool types contained in this scope.", "type": "array", "items": { "$ref": "StoragePoolType" } }, "warning": { "description": "[Output Only] Informational warning which replaces the list of storage pool types when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "StoragePoolList": { "id": "StoragePoolList", "description": "A list of StoragePool resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#storagePoolList for lists of storagePools.", "default": "compute#storagePoolList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of StoragePool resources.", "type": "array", "items": { "$ref": "StoragePool" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "etag": { "type": "string" }, "unreachables": { "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", "type": "array", "items": { "type": "string" } } } }, "StoragePool": { "id": "StoragePool", "description": "Represents a zonal storage pool resource.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#storagePool for storage pools.", "default": "compute#storagePool", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.storagePools.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "poolProvisionedCapacityGb": { "description": "Size, in GiB, of the storage pool. For more information about the size limits, see https:\/\/cloud.google.com\/compute\/docs\/disks\/storage-pools.", "annotations": { "required": [ "compute.storagePools.insert" ] }, "type": "string", "format": "int64" }, "poolProvisionedIops": { "description": "Provisioned IOPS of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced.", "type": "string", "format": "int64" }, "poolProvisionedThroughput": { "description": "Provisioned throughput of the storage pool. Only relevant if the storage pool type is hyperdisk-balanced or hyperdisk-throughput.", "type": "string", "format": "int64" }, "zone": { "description": "[Output Only] URL of the zone where the storage pool resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "state": { "description": "[Output Only] The status of storage pool creation. - CREATING: Storage pool is provisioning. storagePool. - FAILED: Storage pool creation failed. - READY: Storage pool is ready for use. - DELETING: Storage pool is deleting. ", "type": "string", "enumDescriptions": [ "StoragePool is provisioning", "StoragePool is deleting.", "StoragePool creation failed.", "StoragePool is ready for use." ], "enum": [ "CREATING", "DELETING", "FAILED", "READY" ] }, "selfLink": { "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" }, "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource's resource id.", "type": "string" }, "labels": { "description": "Labels to apply to this storage pool. These can be later modified by the setLabels method.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this storage pool, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a storage pool.", "type": "string", "format": "byte" }, "resourceStatus": { "description": "[Output Only] Status information for the storage pool resource.", "$ref": "StoragePoolResourceStatus" }, "storagePoolType": { "description": "Type of the storage pool.", "type": "string" }, "status": { "description": "[Output Only] Status information for the storage pool resource.", "$ref": "StoragePoolResourceStatus" }, "capacityProvisioningType": { "description": "Provisioning type of the byte capacity of the pool.", "type": "string", "enumDescriptions": [ "Advanced provisioning \"thinly\" allocates the related resource.", "Standard provisioning allocates the related resource for the pool disks' exclusive use.", "" ], "enum": [ "ADVANCED", "STANDARD", "UNSPECIFIED" ] }, "performanceProvisioningType": { "description": "Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.", "type": "string", "enumDescriptions": [ "Advanced provisioning \"thinly\" allocates the related resource.", "Standard provisioning allocates the related resource for the pool disks' exclusive use.", "" ], "enum": [ "ADVANCED", "STANDARD", "UNSPECIFIED" ] } } }, "StoragePoolResourceStatus": { "id": "StoragePoolResourceStatus", "description": "[Output Only] Contains output only fields.", "type": "object", "properties": { "lastResizeTimestamp": { "description": "[Output Only] Timestamp of the last successful resize in RFC3339 text format.", "type": "string" }, "diskCount": { "description": "[Output Only] Number of disks used.", "type": "string", "format": "int64" }, "poolUsedCapacityBytes": { "description": "[Output Only] Space used by data stored in disks within the storage pool (in bytes). This will reflect the total number of bytes written to the disks in the pool, in contrast to the capacity of those disks.", "type": "string", "format": "int64" }, "poolUserWrittenBytes": { "description": "[Output Only] Amount of data written into the pool, before it is compacted.", "type": "string", "format": "int64" }, "totalProvisionedDiskCapacityGb": { "description": "[Output Only] Sum of all the capacity provisioned in disks in this storage pool. A disk's provisioned capacity is the same as its total capacity.", "type": "string", "format": "int64" }, "maxTotalProvisionedDiskCapacityGb": { "description": "[Output Only] Maximum allowed aggregate disk size in gigabytes.", "type": "string", "format": "int64" }, "poolUsedIops": { "description": "[Output Only] Sum of all the disks' provisioned IOPS, minus some amount that is allowed per disk that is not counted towards pool's IOPS capacity. For more information, see https:\/\/cloud.google.com\/compute\/docs\/disks\/storage-pools.", "type": "string", "format": "int64" }, "totalProvisionedDiskIops": { "description": "[Output Only] Sum of all the disks' provisioned IOPS.", "type": "string", "format": "int64" }, "poolUsedThroughput": { "description": "[Output Only] Sum of all the disks' provisioned throughput in MB\/s.", "type": "string", "format": "int64" }, "totalProvisionedDiskThroughput": { "description": "[Output Only] Sum of all the disks' provisioned throughput in MB\/s, minus some amount that is allowed per disk that is not counted towards pool's throughput capacity.", "type": "string", "format": "int64" } } }, "StoragePoolAggregatedList": { "id": "StoragePoolAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#storagePoolAggregatedList for aggregated lists of storage pools.", "default": "compute#storagePoolAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of StoragePoolsScopedList resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of storage pool.", "$ref": "StoragePoolsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "etag": { "type": "string" }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "StoragePoolsScopedList": { "id": "StoragePoolsScopedList", "type": "object", "properties": { "storagePools": { "description": "[Output Only] A list of storage pool contained in this scope.", "type": "array", "items": { "$ref": "StoragePool" } }, "warning": { "description": "[Output Only] Informational warning which replaces the list of storage pool when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "StoragePoolListDisks": { "id": "StoragePoolListDisks", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#storagePoolListDisks for lists of disks in a storagePool.", "default": "compute#storagePoolListDisks", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of StoragePoolDisk resources.", "type": "array", "items": { "$ref": "StoragePoolDisk" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "etag": { "type": "string" }, "unreachables": { "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", "type": "array", "items": { "type": "string" } } } }, "StoragePoolDisk": { "id": "StoragePoolDisk", "type": "object", "properties": { "disk": { "description": "[Output Only] The URL of the disk.", "type": "string" }, "name": { "description": "[Output Only] The name of the disk.", "type": "string" }, "status": { "description": "[Output Only] The disk status.", "type": "string", "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 detached." ], "enum": [ "CREATING", "DELETING", "FAILED", "READY", "RESTORING", "UNAVAILABLE" ] }, "type": { "description": "[Output Only] The disk type.", "type": "string" }, "sizeGb": { "description": "[Output Only] The disk size, in GB.", "type": "string", "format": "int64" }, "provisionedIops": { "description": "[Output Only] The number of IOPS provisioned for the disk.", "type": "string", "format": "int64" }, "provisionedThroughput": { "description": "[Output Only] The throughput provisioned for the disk.", "type": "string", "format": "int64" }, "usedBytes": { "description": "[Output Only] Amount of disk space used.", "type": "string", "format": "int64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "attachedInstances": { "description": "[Output Only] Instances this disk is attached to.", "type": "array", "items": { "type": "string" } }, "resourcePolicies": { "description": "[Output Only] Resource policies applied to disk for automatic snapshot creations.", "type": "array", "items": { "type": "string" } } } }, "TargetGrpcProxyList": { "id": "TargetGrpcProxyList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.", "default": "compute#targetGrpcProxyList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetGrpcProxy resources.", "type": "array", "items": { "$ref": "TargetGrpcProxy" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "TargetGrpcProxy": { "id": "TargetGrpcProxy", "description": "Represents a Target gRPC Proxy resource. A target gRPC proxy is a component of load balancers intended for load balancing gRPC traffic. Only global forwarding rules with load balancing scheme INTERNAL_SELF_MANAGED can reference a target gRPC proxy. The target gRPC Proxy references a URL map that specifies how traffic is routed to gRPC backend services.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies.", "default": "compute#targetGrpcProxy", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource type. The server generates this identifier.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.targetGrpcProxies.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "selfLinkWithId": { "description": "[Output Only] Server-defined URL with id for the resource.", "type": "string" }, "urlMap": { "description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC.", "type": "string" }, "validateForProxyless": { "description": "If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use \"xds:\/\/\/\" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use \"xds:\/\/\/\" scheme in the target URI of the service it is connecting to", "type": "boolean" }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetGrpcProxy. An up-to-date fingerprint must be provided in order to patch\/update the TargetGrpcProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetGrpcProxy.", "type": "string", "format": "byte" } } }, "TargetHttpProxyList": { "id": "TargetHttpProxyList", "description": "A list of TargetHttpProxy resources.", "type": "object", "properties": { "kind": { "description": "Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.", "default": "compute#targetHttpProxyList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetHttpProxy resources.", "type": "array", "items": { "$ref": "TargetHttpProxy" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "TargetHttpProxy": { "id": "TargetHttpProxy", "description": "Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](\/compute\/docs\/reference\/rest\/v2\/targetHttpProxies) * [Regional](\/compute\/docs\/reference\/rest\/v2\/regionTargetHttpProxies) A target HTTP proxy is a component of Google Cloud HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.", "default": "compute#targetHttpProxy", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "urlMap": { "description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.", "type": "string" }, "proxyBind": { "description": "This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.", "type": "boolean" }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch\/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy.", "type": "string", "format": "byte" }, "httpKeepAliveTimeoutSec": { "description": "Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For global external Application Load Balancers, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For classic Application Load Balancers, this option is not supported.", "type": "integer", "format": "int32" } } }, "UrlMapReference": { "id": "UrlMapReference", "type": "object", "properties": { "urlMap": { "type": "string" } } }, "TargetHttpProxyAggregatedList": { "id": "TargetHttpProxyAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies.", "default": "compute#targetHttpProxyAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetHttpProxiesScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of TargetHttpProxies.", "$ref": "TargetHttpProxiesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "TargetHttpProxiesScopedList": { "id": "TargetHttpProxiesScopedList", "type": "object", "properties": { "targetHttpProxies": { "description": "A list of TargetHttpProxies contained in this scope.", "type": "array", "items": { "$ref": "TargetHttpProxy" } }, "warning": { "description": "Informational warning which replaces the list of backend services when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "TargetHttpsProxyList": { "id": "TargetHttpsProxyList", "description": "Contains a list of TargetHttpsProxy resources.", "type": "object", "properties": { "kind": { "description": "Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.", "default": "compute#targetHttpsProxyList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetHttpsProxy resources.", "type": "array", "items": { "$ref": "TargetHttpsProxy" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "TargetHttpsProxy": { "id": "TargetHttpsProxy", "description": "Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: [Global](\/compute\/docs\/reference\/rest\/v2\/targetHttpsProxies) * [Regional](\/compute\/docs\/reference\/rest\/v2\/regionTargetHttpsProxies) A target HTTPS proxy is a component of Google Cloud HTTPS load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.", "default": "compute#targetHttpsProxy", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "urlMap": { "description": "A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https:\/\/www.googleapis.compute\/v1\/projects\/project\/global\/urlMaps\/ url-map - projects\/project\/global\/urlMaps\/url-map - global\/urlMaps\/url-map ", "type": "string" }, "sslCertificates": { "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API namespace. Using Certificate Manager Certificates in this field is not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates or up to 100 Certificate Manager Certificates. Certificate Manager Certificates accepted formats are: - \/\/certificatemanager.googleapis.com\/projects\/{project}\/locations\/{ location}\/certificates\/{resourceName}. - https:\/\/certificatemanager.googleapis.com\/v1alpha1\/projects\/{project }\/locations\/{location}\/certificates\/{resourceName}. ", "type": "array", "items": { "type": "string" } }, "certificateMap": { "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is \/\/certificatemanager.googleapis.com\/projects\/{project }\/locations\/{location}\/certificateMaps\/{resourceName}.", "type": "string" }, "quicOverride": { "description": "Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. ", "type": "string", "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 no QUIC override has been specified in the request." ], "enum": [ "DISABLE", "ENABLE", "NONE" ] }, "sslPolicy": { "description": "URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.", "type": "string" }, "proxyBind": { "description": "This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.", "type": "boolean" }, "serverTlsPolicy": { "description": "Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED or INTERNAL_MANAGED. It also applies to a regional TargetHttpsProxy attached to regional forwardingRules with the loadBalancingScheme set to EXTERNAL_MANAGED or INTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, INTERNAL_MANAGED, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted.", "type": "string" }, "authorizationPolicy": { "description": "Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact.", "type": "string" }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.", "type": "string", "format": "byte" }, "httpKeepAliveTimeoutSec": { "description": "Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For global external Application Load Balancers, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For classic Application Load Balancers, this option is not supported.", "type": "integer", "format": "int32" }, "tlsEarlyData": { "description": " Specifies whether TLS 1.3 0-RTT Data (\"Early Data\") should be accepted for this service. Early Data allows a TLS resumption handshake to include the initial application payload (a HTTP request) alongside the handshake, reducing the effective round trips to \"zero\". This applies to TLS 1.3 connections over TCP (HTTP\/2) as well as over UDP (QUIC\/h3). This can improve application performance, especially on networks where interruptions may be common, such as on mobile. Requests with Early Data will have the \"Early-Data\" HTTP header set on the request, with a value of \"1\", to allow the backend to determine whether Early Data was included. Note: TLS Early Data may allow requests to be replayed, as the data is sent to the backend before the handshake has fully completed. Applications that allow idempotent HTTP methods to make non-idempotent changes, such as a GET request updating a database, should not accept Early Data on those requests, and reject requests with the \"Early-Data: 1\" HTTP header by returning a HTTP 425 (Too Early) status code, in order to remain RFC compliant. The default value is DISABLED.", "type": "string", "enumDescriptions": [ "TLS 1.3 Early Data is not advertised, and any (invalid) attempts to send Early Data will be rejected by closing the connection.", "This enables TLS 1.3 0-RTT, and only allows Early Data to be included on requests with safe HTTP methods (GET, HEAD, OPTIONS, TRACE). This mode does not enforce any other limitations for requests with Early Data. The application owner should validate that Early Data is acceptable for a given request path.", "This enables TLS 1.3 0-RTT, and only allows Early Data to be included on requests with safe HTTP methods (GET, HEAD, OPTIONS, TRACE) without query parameters. Requests that send Early Data with non-idempotent HTTP methods or with query parameters will be rejected with a HTTP 425.", "This enables TLS 1.3 Early Data for requests with any HTTP method including non-idempotent methods list POST. This mode does not enforce any other limitations. This may be valuable for gRPC use cases. However, we do not recommend this method unless you have evaluated your security stance and mitigated the risk of replay attacks using other mechanisms." ], "enum": [ "DISABLED", "PERMISSIVE", "STRICT", "UNRESTRICTED" ] } } }, "TargetHttpsProxyAggregatedList": { "id": "TargetHttpsProxyAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies.", "default": "compute#targetHttpsProxyAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetHttpsProxiesScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of TargetHttpsProxies.", "$ref": "TargetHttpsProxiesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "TargetHttpsProxiesScopedList": { "id": "TargetHttpsProxiesScopedList", "type": "object", "properties": { "targetHttpsProxies": { "description": "A list of TargetHttpsProxies contained in this scope.", "type": "array", "items": { "$ref": "TargetHttpsProxy" } }, "warning": { "description": "Informational warning which replaces the list of backend services when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "TargetHttpsProxiesSetSslCertificatesRequest": { "id": "TargetHttpsProxiesSetSslCertificatesRequest", "type": "object", "properties": { "sslCertificates": { "description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.", "type": "array", "items": { "type": "string" } } } }, "TargetHttpsProxiesSetCertificateMapRequest": { "id": "TargetHttpsProxiesSetCertificateMapRequest", "type": "object", "properties": { "certificateMap": { "description": "URL of the Certificate Map to associate with this TargetHttpsProxy. Accepted format is \/\/certificatemanager.googleapis.com\/projects\/{project }\/locations\/{location}\/certificateMaps\/{resourceName}.", "type": "string" } } }, "SslPolicyReference": { "id": "SslPolicyReference", "type": "object", "properties": { "sslPolicy": { "description": "URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.", "type": "string" } } }, "TargetHttpsProxiesSetQuicOverrideRequest": { "id": "TargetHttpsProxiesSetQuicOverrideRequest", "type": "object", "properties": { "quicOverride": { "description": "QUIC policy for the TargetHttpsProxy resource.", "type": "string", "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 no QUIC override has been specified in the request." ], "enum": [ "DISABLE", "ENABLE", "NONE" ] } } }, "RegionTargetHttpsProxiesSetSslCertificatesRequest": { "id": "RegionTargetHttpsProxiesSetSslCertificatesRequest", "type": "object", "properties": { "sslCertificates": { "description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource.", "type": "array", "items": { "type": "string" } } } }, "TargetInstanceList": { "id": "TargetInstanceList", "description": "Contains a list of TargetInstance resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#targetInstanceList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetInstance resources.", "type": "array", "items": { "$ref": "TargetInstance" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "TargetInstance": { "id": "TargetInstance", "description": "Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances.", "type": "object", "properties": { "kind": { "description": "[Output Only] The type of the resource. Always compute#targetInstance for target instances.", "default": "compute#targetInstance", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "zone": { "description": "[Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "natPolicy": { "description": "Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance.", "type": "string", "enumDescriptions": [ "No NAT performed." ], "enum": [ "NO_NAT" ] }, "instance": { "description": "A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/zones\/zone \/instances\/instance - projects\/project\/zones\/zone\/instances\/instance - zones\/zone\/instances\/instance ", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "network": { "description": "The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.", "type": "string" }, "securityPolicy": { "description": "[Output Only] The resource URL for the security policy associated with this target instance.", "type": "string" } } }, "TargetInstanceAggregatedList": { "id": "TargetInstanceAggregatedList", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#targetInstanceAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetInstance resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of target instances.", "$ref": "TargetInstancesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "TargetInstancesScopedList": { "id": "TargetInstancesScopedList", "type": "object", "properties": { "targetInstances": { "description": "A list of target instances contained in this scope.", "type": "array", "items": { "$ref": "TargetInstance" } }, "warning": { "description": "Informational warning which replaces the list of addresses when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "TargetPoolList": { "id": "TargetPoolList", "description": "Contains a list of TargetPool resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.", "default": "compute#targetPoolList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetPool resources.", "type": "array", "items": { "$ref": "TargetPool" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "TargetPool": { "id": "TargetPool", "description": "Represents a Target Pool resource. Target pools are used with external passthrough Network Load Balancers. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#targetPool for target pools.", "default": "compute#targetPool", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the target pool resides.", "type": "string" }, "healthChecks": { "description": "The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.", "type": "array", "items": { "type": "string" } }, "instances": { "description": "A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.", "type": "array", "items": { "type": "string" } }, "sessionAffinity": { "description": "Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.", "type": "string", "enumDescriptions": [ "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.", "1-tuple hash only on packet's source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP\/UDP Load Balancing.", "5-tuple hash on packet's source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.", "3-tuple hash on packet's source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.", "Hash based on a cookie generated by the L7 loadbalancer. Only 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 to any instance in the pool.", "Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired." ], "enum": [ "CLIENT_IP", "CLIENT_IP_NO_DESTINATION", "CLIENT_IP_PORT_PROTO", "CLIENT_IP_PROTO", "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE", "NONE", "STRONG_COOKIE_AFFINITY" ] }, "failoverRatio": { "description": "This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.", "type": "number", "format": "float" }, "backupPool": { "description": "The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "securityPolicy": { "description": "[Output Only] The resource URL for the security policy associated with this target pool.", "type": "string" } } }, "TargetPoolAggregatedList": { "id": "TargetPoolAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.", "default": "compute#targetPoolAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetPool resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of target pools.", "$ref": "TargetPoolsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "TargetPoolsScopedList": { "id": "TargetPoolsScopedList", "type": "object", "properties": { "targetPools": { "description": "A list of target pools contained in this scope.", "type": "array", "items": { "$ref": "TargetPool" } }, "warning": { "description": "Informational warning which replaces the list of addresses when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "TargetPoolInstanceHealth": { "id": "TargetPoolInstanceHealth", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.", "default": "compute#targetPoolInstanceHealth", "type": "string" }, "healthStatus": { "type": "array", "items": { "$ref": "HealthStatus" } } } }, "TargetPoolsAddHealthCheckRequest": { "id": "TargetPoolsAddHealthCheckRequest", "type": "object", "properties": { "healthChecks": { "description": "The HttpHealthCheck to add to the target pool.", "type": "array", "items": { "$ref": "HealthCheckReference" } } } }, "TargetPoolsRemoveHealthCheckRequest": { "id": "TargetPoolsRemoveHealthCheckRequest", "type": "object", "properties": { "healthChecks": { "description": "Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: - https:\/\/www.googleapis.com\/compute\/beta\/projects\/project \/global\/httpHealthChecks\/health-check - projects\/project\/global\/httpHealthChecks\/health-check - global\/httpHealthChecks\/health-check ", "type": "array", "items": { "$ref": "HealthCheckReference" } } } }, "TargetPoolsAddInstanceRequest": { "id": "TargetPoolsAddInstanceRequest", "type": "object", "properties": { "instances": { "description": "A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project-id\/zones\/zone \/instances\/instance-name - projects\/project-id\/zones\/zone\/instances\/instance-name - zones\/zone\/instances\/instance-name ", "type": "array", "items": { "$ref": "InstanceReference" } } } }, "TargetPoolsRemoveInstanceRequest": { "id": "TargetPoolsRemoveInstanceRequest", "type": "object", "properties": { "instances": { "description": "URLs of the instances to be removed from target pool.", "type": "array", "items": { "$ref": "InstanceReference" } } } }, "TargetSslProxyList": { "id": "TargetSslProxyList", "description": "Contains a list of TargetSslProxy resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#targetSslProxyList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetSslProxy resources.", "type": "array", "items": { "$ref": "TargetSslProxy" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "TargetSslProxy": { "id": "TargetSslProxy", "description": "Represents a Target SSL Proxy resource. A target SSL proxy is a component of a Proxy Network Load Balancer. The forwarding rule references the target SSL proxy, and the target proxy then references a backend service. For more information, read Proxy Network Load Balancer overview.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.", "default": "compute#targetSslProxy", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "service": { "description": "URL to the BackendService resource.", "type": "string" }, "sslCertificates": { "description": "URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.", "type": "array", "items": { "type": "string" } }, "certificateMap": { "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is \/\/certificatemanager.googleapis.com\/projects\/{project }\/locations\/{location}\/certificateMaps\/{resourceName}.", "type": "string" }, "proxyHeader": { "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NONE", "PROXY_V1" ] }, "sslPolicy": { "description": "URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.", "type": "string" } } }, "TargetSslProxiesSetBackendServiceRequest": { "id": "TargetSslProxiesSetBackendServiceRequest", "type": "object", "properties": { "service": { "description": "The URL of the new BackendService resource for the targetSslProxy.", "type": "string" } } }, "TargetSslProxiesSetSslCertificatesRequest": { "id": "TargetSslProxiesSetSslCertificatesRequest", "type": "object", "properties": { "sslCertificates": { "description": "New set of URLs to SslCertificate resources to associate with this TargetSslProxy. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.", "type": "array", "items": { "type": "string" } } } }, "TargetSslProxiesSetCertificateMapRequest": { "id": "TargetSslProxiesSetCertificateMapRequest", "type": "object", "properties": { "certificateMap": { "description": "URL of the Certificate Map to associate with this TargetSslProxy. Accepted format is \/\/certificatemanager.googleapis.com\/projects\/{project }\/locations\/{location}\/certificateMaps\/{resourceName}.", "type": "string" } } }, "TargetSslProxiesSetProxyHeaderRequest": { "id": "TargetSslProxiesSetProxyHeaderRequest", "type": "object", "properties": { "proxyHeader": { "description": "The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NONE", "PROXY_V1" ] } } }, "TargetTcpProxyList": { "id": "TargetTcpProxyList", "description": "Contains a list of TargetTcpProxy resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#targetTcpProxyList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetTcpProxy resources.", "type": "array", "items": { "$ref": "TargetTcpProxy" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "TargetTcpProxy": { "id": "TargetTcpProxy", "description": "Represents a Target TCP Proxy resource. A target TCP proxy is a component of a Proxy Network Load Balancer. The forwarding rule references the target TCP proxy, and the target proxy then references a backend service. For more information, read Proxy Network Load Balancer overview.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.", "default": "compute#targetTcpProxy", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "service": { "description": "URL to the BackendService resource.", "type": "string" }, "proxyHeader": { "description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NONE", "PROXY_V1" ] }, "proxyBind": { "description": "This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.", "type": "boolean" }, "region": { "description": "[Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy.", "type": "string" } } }, "TargetTcpProxyAggregatedList": { "id": "TargetTcpProxyAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#targetTcpProxyAggregatedList for lists of Target TCP Proxies.", "default": "compute#targetTcpProxyAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetTcpProxiesScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of TargetTcpProxies.", "$ref": "TargetTcpProxiesScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "TargetTcpProxiesScopedList": { "id": "TargetTcpProxiesScopedList", "type": "object", "properties": { "targetTcpProxies": { "description": "A list of TargetTcpProxies contained in this scope.", "type": "array", "items": { "$ref": "TargetTcpProxy" } }, "warning": { "description": "Informational warning which replaces the list of backend services when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "TargetTcpProxiesSetBackendServiceRequest": { "id": "TargetTcpProxiesSetBackendServiceRequest", "type": "object", "properties": { "service": { "description": "The URL of the new BackendService resource for the targetTcpProxy.", "type": "string" } } }, "TargetTcpProxiesSetProxyHeaderRequest": { "id": "TargetTcpProxiesSetProxyHeaderRequest", "type": "object", "properties": { "proxyHeader": { "description": "The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "NONE", "PROXY_V1" ] } } }, "TargetVpnGatewayList": { "id": "TargetVpnGatewayList", "description": "Contains a list of TargetVpnGateway resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.", "default": "compute#targetVpnGatewayList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetVpnGateway resources.", "type": "array", "items": { "$ref": "TargetVpnGateway" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "TargetVpnGateway": { "id": "TargetVpnGateway", "description": "Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.", "default": "compute#targetVpnGateway", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.targetVpnGateways.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "network": { "description": "URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.", "annotations": { "required": [ "compute.targetVpnGateways.insert" ] }, "type": "string" }, "tunnels": { "description": "[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.", "type": "array", "items": { "type": "string" } }, "status": { "description": "[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.", "type": "string", "enumDescriptions": [ "", "", "", "" ], "enum": [ "CREATING", "DELETING", "FAILED", "READY" ] }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "forwardingRules": { "description": "[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.", "type": "array", "items": { "type": "string" } }, "labels": { "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key\/value pair must comply with RFC1035. Label values may be empty.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.", "type": "string", "format": "byte" } } }, "TargetVpnGatewayAggregatedList": { "id": "TargetVpnGatewayAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.", "default": "compute#targetVpnGatewayAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of TargetVpnGateway resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of target VPN gateways.", "$ref": "TargetVpnGatewaysScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "TargetVpnGatewaysScopedList": { "id": "TargetVpnGatewaysScopedList", "type": "object", "properties": { "targetVpnGateways": { "description": "[Output Only] A list of target VPN gateways contained in this scope.", "type": "array", "items": { "$ref": "TargetVpnGateway" } }, "warning": { "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "UrlMapList": { "id": "UrlMapList", "description": "Contains a list of UrlMap resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#urlMapList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of UrlMap resources.", "type": "array", "items": { "$ref": "UrlMap" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "UrlMap": { "id": "UrlMap", "description": "Represents a URL Map resource. Compute Engine has two URL Map resources: * [Global](\/compute\/docs\/reference\/rest\/v2\/urlMaps) * [Regional](\/compute\/docs\/reference\/rest\/v2\/regionUrlMaps) A URL map resource is a component of certain types of cloud load balancers and Traffic Director: * urlMaps are used by global external Application Load Balancers, classic Application Load Balancers, and cross-region internal Application Load Balancers. * regionUrlMaps are used by internal Application Load Balancers, regional external Application Load Balancers and regional internal Application Load Balancers. For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL, EXTERNAL_MANAGED, or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#urlMaps for url maps.", "default": "compute#urlMap", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "hostRules": { "description": "The list of host rules to use against the URL.", "type": "array", "items": { "$ref": "HostRule" } }, "pathMatchers": { "description": "The list of named PathMatchers to use against the URL.", "type": "array", "items": { "$ref": "PathMatcher" } }, "tests": { "description": "The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.", "type": "array", "items": { "$ref": "UrlMapTest" } }, "defaultService": { "description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", "type": "string" }, "defaultRouteAction": { "description": "defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", "$ref": "HttpRouteAction" }, "defaultUrlRedirect": { "description": "When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy.", "$ref": "HttpRedirectAction" }, "headerAction": { "description": "Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.", "$ref": "HttpHeaderAction" }, "defaultCustomErrorResponsePolicy": { "description": "defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for .example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http:\/\/www.example.com\/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http:\/\/www.example.com\/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in .example.com such as http:\/\/www.myotherexample.com\/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.", "$ref": "CustomErrorResponsePolicy" }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap.", "type": "string", "format": "byte" }, "region": { "description": "[Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" } } }, "HostRule": { "id": "HostRule", "description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.", "type": "object", "properties": { "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "hosts": { "description": "The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. matches any string of ([a-z0-9-.]). In that case, must be the first character, and if followed by anything, the immediate following character must be either - or .. * based matching is not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", "type": "array", "items": { "type": "string" } }, "pathMatcher": { "description": "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.", "type": "string" } } }, "PathMatcher": { "id": "PathMatcher", "description": "A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used.", "type": "object", "properties": { "name": { "description": "The name to which this PathMatcher is referred by the HostRule.", "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "defaultService": { "description": "The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project \/global\/backendServices\/backendService - compute\/v1\/projects\/project\/global\/backendServices\/backendService - global\/backendServices\/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use ", "type": "string" }, "defaultRouteAction": { "description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction.", "$ref": "HttpRouteAction" }, "defaultUrlRedirect": { "description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy.", "$ref": "HttpRedirectAction" }, "pathRules": { "description": "The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path \/a\/b\/c\/* will match before \/a\/b\/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set.", "type": "array", "items": { "$ref": "PathRule" } }, "routeRules": { "description": "The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules.", "type": "array", "items": { "$ref": "HttpRouteRule" } }, "headerAction": { "description": "Specifies changes to request and response headers that need to take effect for the selected backend service. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.", "$ref": "HttpHeaderAction" }, "defaultCustomErrorResponsePolicy": { "description": "defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy is configured with policies for 5xx and 4xx errors - A RouteRule for \/coming_soon\/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com\/current_events\/, the pathMatcher's policy takes effect. If however, the request for www.example.com\/coming_soon\/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers.", "$ref": "CustomErrorResponsePolicy" } } }, "HttpRouteAction": { "id": "HttpRouteAction", "type": "object", "properties": { "weightedBackendServices": { "description": "A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number. After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.", "type": "array", "items": { "$ref": "WeightedBackendService" } }, "urlRewrite": { "description": "The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for classic Application Load Balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", "$ref": "UrlRewrite" }, "timeout": { "description": "Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as end-of-stream) up until the response has been processed. Timeout includes all retries. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.", "$ref": "Duration" }, "retryPolicy": { "description": "Specifies the retry policy associated with this route.", "$ref": "HttpRetryPolicy" }, "requestMirrorPolicy": { "description": "Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host \/ authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", "$ref": "RequestMirrorPolicy" }, "corsPolicy": { "description": "The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy.", "$ref": "CorsPolicy" }, "faultInjectionPolicy": { "description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout and retry_policy is ignored by clients that are configured with a fault_injection_policy if: 1. The traffic is generated by fault injection AND 2. The fault injection is not a delay fault injection. Fault injection is not supported with the classic Application Load Balancer . To see which load balancers support fault injection, see Load balancing: Routing and traffic management features.", "$ref": "HttpFaultInjection" }, "maxStreamDuration": { "description": "Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (known as end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been processed, including all retries. A stream that does not complete in this duration is closed. If not specified, this field uses the maximum maxStreamDuration value among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.", "$ref": "Duration" } } }, "WeightedBackendService": { "id": "WeightedBackendService", "description": "In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple backend services. The volume of traffic for each backend service is proportional to the weight specified in each WeightedBackendService", "type": "object", "properties": { "backendService": { "description": "The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the load balancer applies any relevant headerActions specified as part of this backendServiceWeight.", "type": "string" }, "weight": { "description": "Specifies the fraction of traffic sent to a backend service, computed as weight \/ (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000.", "type": "integer", "format": "uint32" }, "headerAction": { "description": "Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.", "$ref": "HttpHeaderAction" } } }, "HttpHeaderAction": { "id": "HttpHeaderAction", "description": "The request and response header transformations that take effect before the request is passed along to the selected backendService.", "type": "object", "properties": { "requestHeadersToRemove": { "description": "A list of header names for headers that need to be removed from the request before forwarding the request to the backendService.", "type": "array", "items": { "type": "string" } }, "requestHeadersToAdd": { "description": "Headers to add to a matching request before forwarding the request to the backendService.", "type": "array", "items": { "$ref": "HttpHeaderOption" } }, "responseHeadersToRemove": { "description": "A list of header names for headers that need to be removed from the response before sending the response back to the client.", "type": "array", "items": { "type": "string" } }, "responseHeadersToAdd": { "description": "Headers to add the response before sending the response back to the client.", "type": "array", "items": { "$ref": "HttpHeaderOption" } } } }, "HttpHeaderOption": { "id": "HttpHeaderOption", "description": "Specification determining how headers are added to requests or responses.", "type": "object", "properties": { "headerName": { "description": "The name of the header.", "type": "string" }, "headerValue": { "description": "The value of the header to add.", "type": "string" }, "replace": { "description": "If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false. ", "type": "boolean" } } }, "UrlRewrite": { "id": "UrlRewrite", "description": "The spec for modifying the path before sending the request to the matched backend service.", "type": "object", "properties": { "pathPrefixRewrite": { "description": "Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.", "type": "string" }, "hostRewrite": { "description": "Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be from 1 to 255 characters.", "type": "string" }, "pathTemplateRewrite": { "description": " If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field. - -At least one variable must be specified in the path_template_match field - You can omit variables from the rewritten URL - The * and ** operators cannot be matched unless they have a corresponding variable name - e.g. {format=} or {var=}. For example, a path_template_match of \/static\/{format=} could be rewritten as \/static\/content\/{format} to prefix \/content to the URL. Variables can also be re-ordered in a rewrite, so that \/{country}\/{format}\/{suffix=} can be rewritten as \/content\/{format}\/{country}\/{suffix}. At least one non-empty routeRules[].matchRules[].path_template_match is required. Only one of path_prefix_rewrite or path_template_rewrite may be specified.", "type": "string" } } }, "HttpRetryPolicy": { "id": "HttpRetryPolicy", "description": "The retry policy associates with HttpRouteRule", "type": "object", "properties": { "retryConditions": { "description": "Specifies one or more conditions when this retry policy applies. Valid values are: - 5xx: retry is attempted if the instance or endpoint responds with any 5xx response code, or if the instance or endpoint does not respond at all. For example, disconnects, reset, read timeout, connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - connect-failure: a retry is attempted on failures connecting to the instance or endpoint. For example, connection timeouts. - retriable-4xx: a retry is attempted if the instance or endpoint responds with a 4xx response code. The only error that you can retry is error code 409. - refused-stream: a retry is attempted if the instance or endpoint resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: a retry is attempted if the gRPC status code in the response header is set to cancelled. - deadline-exceeded: a retry is attempted if the gRPC status code in the response header is set to deadline-exceeded. - internal: a retry is attempted if the gRPC status code in the response header is set to internal. - resource-exhausted: a retry is attempted if the gRPC status code in the response header is set to resource-exhausted. - unavailable: a retry is attempted if the gRPC status code in the response header is set to unavailable. Only the following codes are supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true. - cancelled - deadline-exceeded - internal - resource-exhausted - unavailable ", "type": "array", "items": { "type": "string" } }, "numRetries": { "description": "Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.", "type": "integer", "format": "uint32" }, "perTryTimeout": { "description": "Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in the HttpRouteAction field. If timeout in the HttpRouteAction field is not set, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", "$ref": "Duration" } } }, "RequestMirrorPolicy": { "id": "RequestMirrorPolicy", "description": "A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow.", "type": "object", "properties": { "backendService": { "description": "The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. ", "type": "string" } } }, "CorsPolicy": { "id": "CorsPolicy", "description": "The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard.", "type": "object", "properties": { "allowOrigins": { "description": "Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.", "type": "array", "items": { "type": "string" } }, "allowOriginRegexes": { "description": "Specifies a regular expression that matches allowed origins. For more information, see regular expression syntax . An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", "type": "array", "items": { "type": "string" } }, "allowMethods": { "description": "Specifies the content for the Access-Control-Allow-Methods header.", "type": "array", "items": { "type": "string" } }, "allowHeaders": { "description": "Specifies the content for the Access-Control-Allow-Headers header.", "type": "array", "items": { "type": "string" } }, "exposeHeaders": { "description": "Specifies the content for the Access-Control-Expose-Headers header.", "type": "array", "items": { "type": "string" } }, "maxAge": { "description": "Specifies how long results of a preflight request can be cached in seconds. This field translates to the Access-Control-Max-Age header.", "type": "integer", "format": "int32" }, "allowCredentials": { "description": "In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false.", "type": "boolean" }, "disabled": { "description": "If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect.", "type": "boolean" } } }, "HttpFaultInjection": { "id": "HttpFaultInjection", "description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by the load balancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests.", "type": "object", "properties": { "delay": { "description": "The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.", "$ref": "HttpFaultDelay" }, "abort": { "description": "The specification for how client requests are aborted as part of fault injection.", "$ref": "HttpFaultAbort" } } }, "HttpFaultDelay": { "id": "HttpFaultDelay", "description": "Specifies the delay introduced by the load balancer before forwarding the request to the backend service as part of fault injection.", "type": "object", "properties": { "fixedDelay": { "description": "Specifies the value of the fixed delay interval.", "$ref": "Duration" }, "percentage": { "description": "The percentage of traffic for connections, operations, or requests for which a delay is introduced as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", "type": "number", "format": "double" } } }, "HttpFaultAbort": { "id": "HttpFaultAbort", "description": "Specification for how requests are aborted as part of fault injection.", "type": "object", "properties": { "httpStatus": { "description": "The HTTP status code used to abort the request. The value must be from 200 to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.", "type": "integer", "format": "uint32" }, "percentage": { "description": "The percentage of traffic for connections, operations, or requests that is aborted as part of fault injection. The value must be from 0.0 to 100.0 inclusive.", "type": "number", "format": "double" } } }, "HttpRedirectAction": { "id": "HttpRedirectAction", "description": "Specifies settings for an HTTP redirect.", "type": "object", "properties": { "hostRedirect": { "description": "The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters.", "type": "string" }, "pathRedirect": { "description": "The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.", "type": "string" }, "prefixRedirect": { "description": "The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters.", "type": "string" }, "redirectResponseCode": { "description": "The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method is retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method is retained. ", "type": "string", "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." ], "enum": [ "FOUND", "MOVED_PERMANENTLY_DEFAULT", "PERMANENT_REDIRECT", "SEE_OTHER", "TEMPORARY_REDIRECT" ] }, "httpsRedirect": { "description": "If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.", "type": "boolean" }, "stripQuery": { "description": "If set to true, any accompanying query portion of the original URL is removed before redirecting the request. If set to false, the query portion of the original URL is retained. The default is set to false. ", "type": "boolean" } } }, "PathRule": { "id": "PathRule", "description": "A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.", "type": "object", "properties": { "service": { "description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set.", "type": "string" }, "routeAction": { "description": "In response to a matching path, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path rule's routeAction.", "$ref": "HttpRouteAction" }, "urlRedirect": { "description": "When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy.", "$ref": "HttpRedirectAction" }, "paths": { "description": "The list of path patterns to match. Each must start with \/ and the only place a is allowed is at the end following a \/. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.", "type": "array", "items": { "type": "string" } }, "customErrorResponsePolicy": { "description": "customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the PathRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A PathRule for \/coming_soon\/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com\/current_events\/, the pathMatcher's policy takes effect. If however, the request for www.example.com\/coming_soon\/ encounters a 404, the policy in PathRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. customErrorResponsePolicy is supported only for global external Application Load Balancers.", "$ref": "CustomErrorResponsePolicy" } } }, "CustomErrorResponsePolicy": { "id": "CustomErrorResponsePolicy", "description": "Specifies the custom error response policy that must be applied when the backend service or backend bucket responds with an error.", "type": "object", "properties": { "errorResponseRules": { "description": "Specifies rules for returning error responses. In a given policy, if you specify rules for both a range of error codes as well as rules for specific error codes then rules with specific error codes have a higher priority. For example, assume that you configure a rule for 401 (Un-authorized) code, and another for all 4 series error codes (4XX). If the backend service returns a 401, then the rule for 401 will be applied. However if the backend service returns a 403, the rule for 4xx takes effect.", "type": "array", "items": { "$ref": "CustomErrorResponsePolicyCustomErrorResponseRule" } }, "errorService": { "description": "The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/global\/backendBuckets\/myBackendBucket - compute\/v1\/projects\/project\/global\/backendBuckets\/myBackendBucket - global\/backendBuckets\/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP\/HTTPS load balancers.", "type": "string" } } }, "CustomErrorResponsePolicyCustomErrorResponseRule": { "id": "CustomErrorResponsePolicyCustomErrorResponseRule", "description": "Specifies the mapping between the response code that will be returned along with the custom error content and the response code returned by the backend service.", "type": "object", "properties": { "matchResponseCodes": { "description": "Valid values include: - A number between 400 and 599: For example 401 or 503, in which case the load balancer applies the policy if the error code exactly matches this value. - 5xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 500 to 599. - 4xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 400 to 499. Values must be unique within matchResponseCodes and across all errorResponseRules of CustomErrorResponsePolicy.", "type": "array", "items": { "type": "string" } }, "path": { "description": "The full path to a file within backendBucket . For example: \/errors\/defaultError.html path must start with a leading slash. path cannot have trailing slashes. If the file is not available in backendBucket or the load balancer cannot reach the BackendBucket, a simple Not Found Error is returned to the client. The value must be from 1 to 1024 characters", "type": "string" }, "overrideResponseCode": { "description": "The HTTP status code returned with the response containing the custom error content. If overrideResponseCode is not supplied, the same response code returned by the original backend bucket or backend service is returned to the client.", "type": "integer", "format": "int32" } } }, "HttpRouteRule": { "id": "HttpRouteRule", "description": "The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform.", "type": "object", "properties": { "priority": { "description": "For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.", "type": "integer", "format": "int32" }, "description": { "description": "The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.", "type": "string" }, "matchRules": { "description": "The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.", "type": "array", "items": { "$ref": "HttpRouteRuleMatch" } }, "service": { "description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set.", "type": "string" }, "routeAction": { "description": "In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a route rule's routeAction.", "$ref": "HttpRouteAction" }, "urlRedirect": { "description": "When this rule is matched, the request is redirected to a URL specified by urlRedirect. Only one of urlRedirect, service or routeAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy.", "$ref": "HttpRedirectAction" }, "headerAction": { "description": "Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction value specified here is applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction HeaderAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.", "$ref": "HttpHeaderAction" }, "customErrorResponsePolicy": { "description": "customErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. If a policy for an error code is not configured for the RouteRule, a policy for the error code configured in pathMatcher.defaultCustomErrorResponsePolicy is applied. If one is not specified in pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: - UrlMap.defaultCustomErrorResponsePolicy are configured with policies for 5xx and 4xx errors - A RouteRule for \/coming_soon\/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com\/current_events\/, the pathMatcher's policy takes effect. If however, the request for www.example.com\/coming_soon\/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with routeRules.routeAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the customErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the customErrorResponsePolicy is ignored and the response from the service is returned to the client. customErrorResponsePolicy is supported only for global external Application Load Balancers.", "$ref": "CustomErrorResponsePolicy" } } }, "HttpRouteRuleMatch": { "id": "HttpRouteRuleMatch", "description": "HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.", "type": "object", "properties": { "prefixMatch": { "description": "For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a \/. The value must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.", "type": "string" }, "fullPathMatch": { "description": "For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL. fullPathMatch must be from 1 to 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.", "type": "string" }, "regexMatch": { "description": "For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For more information about regular expression syntax, see Syntax. Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", "type": "string" }, "ignoreCase": { "description": "Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to a target gRPC proxy.", "type": "boolean" }, "headerMatches": { "description": "Specifies a list of header match criteria, all of which must match corresponding headers in the request.", "type": "array", "items": { "$ref": "HttpHeaderMatch" } }, "queryParameterMatches": { "description": "Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to a target gRPC proxy.", "type": "array", "items": { "$ref": "HttpQueryParameterMatch" } }, "metadataFilters": { "description": "Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to the load balancer, xDS clients present node metadata. When there is a match, the relevant routing configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadata filters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here is applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to load balancers that have loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.", "type": "array", "items": { "$ref": "MetadataFilter" } }, "pathTemplateMatch": { "description": "If specified, the route is a pattern match expression that must match the :path header once the query string is removed. A pattern match allows you to match - The value must be between 1 and 1024 characters - The pattern must start with a leading slash (\"\/\") - There may be no more than 5 operators in pattern Precisely one of prefix_match, full_path_match, regex_match or path_template_match must be set.", "type": "string" } } }, "HttpHeaderMatch": { "id": "HttpHeaderMatch", "description": "matchRule criteria for request header matches.", "type": "object", "properties": { "headerName": { "description": "The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name \":authority\". For matching a request's method, use the headerName \":method\". When the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin`.", "type": "string" }, "exactMatch": { "description": "The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", "type": "string" }, "regexMatch": { "description": "The value of the header must match the regular expression specified in regexMatch. For more information about regular expression syntax, see Syntax. For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.", "type": "string" }, "rangeMatch": { "description": "The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. rangeMatch is not supported for load balancers that have loadBalancingScheme set to EXTERNAL.", "$ref": "Int64RangeMatch" }, "presentMatch": { "description": "A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", "type": "boolean" }, "prefixMatch": { "description": "The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", "type": "string" }, "suffixMatch": { "description": "The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.", "type": "string" }, "invertMatch": { "description": "If set to false, the headerMatch is considered a match if the preceding match criteria are met. If set to true, the headerMatch is considered a match if the preceding match criteria are NOT met. The default setting is false. ", "type": "boolean" } } }, "Int64RangeMatch": { "id": "Int64RangeMatch", "description": "HttpRouteRuleMatch criteria for field values that must stay within the specified integer range.", "type": "object", "properties": { "rangeStart": { "description": "The start of the range (inclusive) in signed long integer format.", "type": "string", "format": "int64" }, "rangeEnd": { "description": "The end of the range (exclusive) in signed long integer format.", "type": "string", "format": "int64" } } }, "HttpQueryParameterMatch": { "id": "HttpQueryParameterMatch", "description": "HttpRouteRuleMatch criteria for a request's query parameter.", "type": "object", "properties": { "name": { "description": "The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.", "type": "string" }, "presentMatch": { "description": "Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not. Only one of presentMatch, exactMatch, or regexMatch must be set. ", "type": "boolean" }, "exactMatch": { "description": "The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch, or regexMatch must be set. ", "type": "string" }, "regexMatch": { "description": "The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For more information about regular expression syntax, see Syntax. Only one of presentMatch, exactMatch, or regexMatch must be set. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. ", "type": "string" } } }, "UrlMapTest": { "id": "UrlMapTest", "description": "Message for the expected URL mappings.", "type": "object", "properties": { "description": { "description": "Description of this test case.", "type": "string" }, "host": { "description": "Host portion of the URL. If headers contains a host header, then host must also match the header value.", "type": "string" }, "path": { "description": "Path portion of the URL.", "type": "string" }, "headers": { "description": "HTTP headers for this request. If headers contains a host header, then host must also match the header value.", "type": "array", "items": { "$ref": "UrlMapTestHeader" } }, "service": { "description": "Expected BackendService or BackendBucket resource the given URL should be mapped to. The service field cannot be set if expectedRedirectResponseCode is set.", "type": "string" }, "expectedOutputUrl": { "description": "The expected output URL evaluated by the load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by the load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to HTTPS. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.", "type": "string" }, "expectedRedirectResponseCode": { "description": "For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.", "type": "integer", "format": "int32" } } }, "UrlMapTestHeader": { "id": "UrlMapTestHeader", "description": "HTTP headers used in UrlMapTests.", "type": "object", "properties": { "name": { "description": "Header name.", "type": "string" }, "value": { "description": "Header value.", "type": "string" } } }, "UrlMapsAggregatedList": { "id": "UrlMapsAggregatedList", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#urlMapsAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of UrlMapsScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of UrlMaps.", "$ref": "UrlMapsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "UrlMapsScopedList": { "id": "UrlMapsScopedList", "type": "object", "properties": { "urlMaps": { "description": "A list of UrlMaps contained in this scope.", "type": "array", "items": { "$ref": "UrlMap" } }, "warning": { "description": "Informational warning which replaces the list of backend services when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "UrlMapsValidateRequest": { "id": "UrlMapsValidateRequest", "type": "object", "properties": { "resource": { "description": "Content of the UrlMap to be validated.", "$ref": "UrlMap" }, "loadBalancingSchemes": { "description": "Specifies the load balancer type(s) this validation request is for. Use EXTERNAL_MANAGED for global external Application Load Balancers and regional external Application Load Balancers. Use EXTERNAL for classic Application Load Balancers. Use INTERNAL_MANAGED for internal Application Load Balancers. For more information, refer to Choosing a load balancer. If unspecified, the load balancing scheme will be inferred from the backend service resources this URL map references. If that can not be inferred (for example, this URL map only references backend buckets, or this Url map is for rewrites and redirects only and doesn't reference any backends), EXTERNAL will be used as the default type. If specified, the scheme(s) must not conflict with the load balancing scheme of the backend service resources this Url map references.", "type": "array", "items": { "type": "string", "enumDescriptions": [ "Signifies that this will be used for classic Application Load Balancers.", "Signifies that this will be used for Envoy-based global external Application Load Balancers.", "If unspecified, the validation will try to infer the scheme from the backend service resources this Url map references. If the inference is not possible, EXTERNAL will be used as the default type." ], "enum": [ "EXTERNAL", "EXTERNAL_MANAGED", "LOAD_BALANCING_SCHEME_UNSPECIFIED" ] } } } }, "UrlMapsValidateResponse": { "id": "UrlMapsValidateResponse", "type": "object", "properties": { "result": { "$ref": "UrlMapValidationResult" } } }, "UrlMapValidationResult": { "id": "UrlMapValidationResult", "description": "Message representing the validation result for a UrlMap.", "type": "object", "properties": { "loadSucceeded": { "description": "Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.", "type": "boolean" }, "loadErrors": { "type": "array", "items": { "type": "string" } }, "testPassed": { "description": "If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.", "type": "boolean" }, "testFailures": { "type": "array", "items": { "$ref": "TestFailure" } } } }, "TestFailure": { "id": "TestFailure", "type": "object", "properties": { "host": { "description": "Host portion of the URL.", "type": "string" }, "path": { "description": "Path portion including query parameters in the URL.", "type": "string" }, "headers": { "description": "HTTP headers of the request.", "type": "array", "items": { "$ref": "UrlMapTestHeader" } }, "expectedService": { "description": "Expected BackendService or BackendBucket resource the given URL should be mapped to.", "type": "string" }, "actualService": { "description": "BackendService or BackendBucket returned by load balancer.", "type": "string" }, "expectedOutputUrl": { "description": "The expected output URL evaluated by a load balancer containing the scheme, host, path and query parameters.", "type": "string" }, "actualOutputUrl": { "description": "The actual output URL evaluated by a load balancer containing the scheme, host, path and query parameters.", "type": "string" }, "expectedRedirectResponseCode": { "description": "Expected HTTP status code for rule with `urlRedirect` calculated by load balancer", "type": "integer", "format": "int32" }, "actualRedirectResponseCode": { "description": "Actual HTTP status code for rule with `urlRedirect` calculated by load balancer", "type": "integer", "format": "int32" } } }, "CacheInvalidationRule": { "id": "CacheInvalidationRule", "type": "object", "properties": { "path": { "type": "string" }, "host": { "description": "If set, this invalidation rule will only apply to requests with a Host header matching host.", "type": "string" } } }, "RegionUrlMapsValidateRequest": { "id": "RegionUrlMapsValidateRequest", "type": "object", "properties": { "resource": { "description": "Content of the UrlMap to be validated.", "$ref": "UrlMap" } } }, "VpnGatewayList": { "id": "VpnGatewayList", "description": "Contains a list of VpnGateway resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.", "default": "compute#vpnGatewayList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of VpnGateway resources.", "type": "array", "items": { "$ref": "VpnGateway" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "VpnGateway": { "id": "VpnGateway", "description": "Represents a HA VPN gateway. HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies .", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.", "default": "compute#vpnGateway", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.vpnGateways.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the VPN gateway resides.", "type": "string" }, "network": { "description": "URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.", "annotations": { "required": [ "compute.vpnGateways.insert" ] }, "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "labels": { "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key\/value pair must comply with RFC1035. Label values may be empty.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnGateway.", "type": "string", "format": "byte" }, "vpnInterfaces": { "description": "The list of VPN interfaces associated with this VPN gateway.", "type": "array", "items": { "$ref": "VpnGatewayVpnGatewayInterface" } }, "stackType": { "description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.", "type": "string", "enumDescriptions": [ "Enable VPN gateway with both IPv4 and IPv6 protocols.", "Enable VPN gateway with only IPv4 protocol.", "Enable VPN gateway with only IPv6 protocol." ], "enum": [ "IPV4_IPV6", "IPV4_ONLY", "IPV6_ONLY" ] }, "gatewayIpVersion": { "description": "The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used.", "type": "string", "enumDescriptions": [ "Every HA-VPN gateway interface is configured with an IPv4 address.", "Every HA-VPN gateway interface is configured with an IPv6 address." ], "enum": [ "IPV4", "IPV6" ] } } }, "VpnGatewayVpnGatewayInterface": { "id": "VpnGatewayVpnGatewayInterface", "description": "A VPN gateway interface.", "type": "object", "properties": { "id": { "description": "[Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.", "type": "integer", "format": "uint32" }, "ipAddress": { "description": "[Output Only] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For HA VPN over Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non HA VPN over Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address.", "type": "string" }, "ipv6Address": { "description": "[Output Only] IPv6 address for this VPN interface associated with the VPN gateway. The IPv6 address must be a regional external IPv6 address. The format is RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).", "type": "string" }, "interconnectAttachment": { "description": "URL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for HA VPN over Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource.", "type": "string" } } }, "VpnGatewayAggregatedList": { "id": "VpnGatewayAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.", "default": "compute#vpnGatewayAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of VpnGateway resources.", "type": "object", "additionalProperties": { "description": "[Output Only] Name of the scope containing this set of VPN gateways.", "$ref": "VpnGatewaysScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "VpnGatewaysScopedList": { "id": "VpnGatewaysScopedList", "type": "object", "properties": { "vpnGateways": { "description": "[Output Only] A list of VPN gateways contained in this scope.", "type": "array", "items": { "$ref": "VpnGateway" } }, "warning": { "description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "VpnGatewaysGetStatusResponse": { "id": "VpnGatewaysGetStatusResponse", "type": "object", "properties": { "result": { "$ref": "VpnGatewayStatus" } } }, "VpnGatewayStatus": { "id": "VpnGatewayStatus", "type": "object", "properties": { "vpnConnections": { "description": "List of VPN connection for this VpnGateway.", "type": "array", "items": { "$ref": "VpnGatewayStatusVpnConnection" } } } }, "VpnGatewayStatusVpnConnection": { "id": "VpnGatewayStatusVpnConnection", "description": "A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be an external VPN gateway or a Google Cloud VPN gateway.", "type": "object", "properties": { "peerExternalGateway": { "description": "URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.", "type": "string" }, "peerGcpGateway": { "description": "URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.", "type": "string" }, "tunnels": { "description": "List of VPN tunnels that are in this VPN connection.", "type": "array", "items": { "$ref": "VpnGatewayStatusTunnel" } }, "state": { "description": "HighAvailabilityRequirementState for the VPN connection.", "$ref": "VpnGatewayStatusHighAvailabilityRequirementState" } } }, "VpnGatewayStatusTunnel": { "id": "VpnGatewayStatusTunnel", "description": "Contains some information about a VPN tunnel.", "type": "object", "properties": { "localGatewayInterface": { "description": "The VPN gateway interface this VPN tunnel is associated with.", "type": "integer", "format": "uint32" }, "peerGatewayInterface": { "description": "The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or a Google Cloud VPN gateway.", "type": "integer", "format": "uint32" }, "tunnelUrl": { "description": "URL reference to the VPN tunnel.", "type": "string" } } }, "VpnGatewayStatusHighAvailabilityRequirementState": { "id": "VpnGatewayStatusHighAvailabilityRequirementState", "description": "Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway.", "type": "object", "properties": { "state": { "description": "Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET.", "type": "string", "enumDescriptions": [ "VPN tunnels are configured with adequate redundancy from Cloud VPN gateway to the peer VPN gateway. For both GCP-to-non-GCP and GCP-to-GCP connections, the adequate redundancy is a pre-requirement for users to get 99.99% availability on GCP side; please note that for any connection, end-to-end 99.99% availability is subject to proper configuration on the peer VPN gateway.", "VPN tunnels are not configured with adequate redundancy from the Cloud VPN gateway to the peer gateway" ], "enum": [ "CONNECTION_REDUNDANCY_MET", "CONNECTION_REDUNDANCY_NOT_MET" ] }, "unsatisfiedReason": { "description": "Indicates the reason why the VPN connection does not meet the high availability redundancy criteria\/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE.", "type": "string", "enumDescriptions": [ "" ], "enum": [ "INCOMPLETE_TUNNELS_COVERAGE" ] } } }, "VpnTunnelList": { "id": "VpnTunnelList", "description": "Contains a list of VpnTunnel resources.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.", "default": "compute#vpnTunnelList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of VpnTunnel resources.", "type": "array", "items": { "$ref": "VpnTunnel" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "VpnTunnel": { "id": "VpnTunnel", "description": "Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.", "default": "compute#vpnTunnel", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9][a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "annotations": { "required": [ "compute.vpnTunnels.insert" ] }, "type": "string" }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, "region": { "description": "[Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", "type": "string" }, "targetVpnGateway": { "description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This 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. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.", "type": "string" }, "vpnGatewayInterface": { "description": "The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`.", "type": "integer", "format": "int32" }, "peerExternalGateway": { "description": "URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.", "type": "string" }, "peerExternalGatewayInterface": { "description": "The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type.", "type": "integer", "format": "int32" }, "peerGcpGateway": { "description": "URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway.", "type": "string" }, "router": { "description": "URL of the router resource to be used for dynamic routing.", "type": "string" }, "peerIp": { "description": "IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.", "type": "string" }, "sharedSecret": { "description": "Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.", "type": "string" }, "sharedSecretHash": { "description": "Hash of the shared secret.", "type": "string" }, "status": { "description": "[Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. ", "type": "string", "enumDescriptions": [ "Cloud VPN is in the process of allocating all required resources (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, TargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are needed to setup 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" ] }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, "ikeVersion": { "description": "IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.", "type": "integer", "format": "int32" }, "detailedStatus": { "description": "[Output Only] Detailed status message for the VPN tunnel.", "type": "string" }, "localTrafficSelector": { "description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0\/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.", "type": "array", "items": { "type": "string" } }, "remoteTrafficSelector": { "description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0\/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.", "type": "array", "items": { "type": "string" } }, "labels": { "description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key\/value pair must comply with RFC1035. Label values may be empty.", "type": "object", "additionalProperties": { "type": "string" } }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel.", "type": "string", "format": "byte" } } }, "VpnTunnelAggregatedList": { "id": "VpnTunnelAggregatedList", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.", "default": "compute#vpnTunnelAggregatedList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of VpnTunnelsScopedList resources.", "type": "object", "additionalProperties": { "description": "Name of the scope containing this set of VPN tunnels.", "$ref": "VpnTunnelsScopedList" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } }, "unreachables": { "description": "[Output Only] Unreachable resources.", "type": "array", "items": { "type": "string" } } } }, "VpnTunnelsScopedList": { "id": "VpnTunnelsScopedList", "type": "object", "properties": { "vpnTunnels": { "description": "A list of VPN tunnels contained in this scope.", "type": "array", "items": { "$ref": "VpnTunnel" } }, "warning": { "description": "Informational warning which replaces the list of addresses when the list is empty.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "ZoneList": { "id": "ZoneList", "description": "Contains a list of zone resources.", "type": "object", "properties": { "kind": { "description": "Type of resource.", "default": "compute#zoneList", "type": "string" }, "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { "description": "A list of Zone resources.", "type": "array", "items": { "$ref": "Zone" } }, "nextPageToken": { "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", "type": "string" }, "selfLink": { "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "warning": { "description": "[Output Only] Informational warning message.", "type": "object", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", "type": "string", "enumDescriptions": [ "Warning about failed cleanup of transient changes made by a failed operation.", "A link to a deprecated resource was created.", "When deploying and at least one of the resources has a type marked as deprecated", "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 experimental", "Warning that is present in an external api call", "Warning that value of a field has been overridden. Deprecated 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 not 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 which captures the amount of resources filtered out by user-defined list filter.", "A resource depends on a missing type", "The route's nextHopIp address is not assigned to an instance on the network.", "The route's next hop instance cannot ip forward.", "The route's nextHopInstance URL refers to an instance that does not have an ipv6 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 same 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 the 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: regions.list).", "The user attempted to use a resource that requires a TOS they have not accepted.", "Warning that a resource is in use.", "One or more of the resources set to auto-delete could not be deleted because they were in use.", "When a resource schema validation is ignored.", "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", "When undeclared properties in the schema are present", "A given scope cannot be reached." ], "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 ], "enum": [ "CLEANUP_FAILED", "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" ] }, "message": { "description": "[Output Only] A human-readable description of the warning code.", "type": "string" }, "data": { "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones\/us-east1-d\" } ", "type": "array", "items": { "type": "object", "properties": { "key": { "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", "type": "string" }, "value": { "description": "[Output Only] A warning data value corresponding to the key.", "type": "string" } } } } } } } }, "Zone": { "id": "Zone", "description": "Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-b is located in the us-east1 region. For more information, read Regions and Zones.", "type": "object", "properties": { "kind": { "description": "[Output Only] Type of the resource. Always compute#zone for zones.", "default": "compute#zone", "type": "string" }, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "type": "string", "format": "uint64" }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, "name": { "description": "[Output Only] Name of the resource.", "type": "string" }, "description": { "description": "[Output Only] Textual description of the resource.", "type": "string" }, "status": { "description": "[Output Only] Status of the zone, either UP or DOWN.", "type": "string", "enumDescriptions": [ "", "" ], "enum": [ "DOWN", "UP" ] }, "deprecated": { "description": "[Output Only] The deprecation status associated with this zone.", "$ref": "DeprecationStatus" }, "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" }, "availableCpuPlatforms": { "description": "[Output Only] Available cpu\/platform selections for the zone.", "type": "array", "items": { "type": "string" } }, "supportsPzs": { "description": "[Output Only] Reserved for future use.", "type": "boolean" } } } }, "resources": { "globalOperations": { "methods": { "list": { "id": "compute.globalOperations.list", "path": "projects/{project}/global/operations", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/operations", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "OperationList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of Operation resources contained within the specified project." }, "aggregatedList": { "id": "compute.globalOperations.aggregatedList", "path": "projects/{project}/aggregated/operations", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/operations", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "OperationAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.globalOperations.get", "path": "projects/{project}/global/operations/{operation}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/operations/{operation}", "httpMethod": "GET", "parameters": { "operation": { "description": "Name of the Operations resource to return, or its unique numeric identifier.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Retrieves the specified Operations resource." }, "wait": { "id": "compute.globalOperations.wait", "path": "projects/{project}/global/operations/{operation}/wait", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/operations/{operation}/wait", "httpMethod": "POST", "parameters": { "operation": { "description": "Name of the Operations resource to return, or its unique numeric identifier.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. " }, "delete": { "id": "compute.globalOperations.delete", "path": "projects/{project}/global/operations/{operation}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/operations/{operation}", "httpMethod": "DELETE", "parameters": { "operation": { "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "operation" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified Operations resource." } } }, "globalOrganizationOperations": { "methods": { "list": { "id": "compute.globalOrganizationOperations.list", "path": "locations/global/operations", "apiVersion": "2024-12-01", "flatPath": "locations/global/operations", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "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 of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "response": { "$ref": "OperationList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of Operation resources contained within the specified organization." }, "get": { "id": "compute.globalOrganizationOperations.get", "path": "locations/global/operations/{operation}", "apiVersion": "2024-12-01", "flatPath": "locations/global/operations/{operation}", "httpMethod": "GET", "parameters": { "operation": { "description": "Name of the Operations resource to return, or its unique numeric identifier.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "parentId": { "description": "Parent ID for this request.", "location": "query", "type": "string" } }, "parameterOrder": [ "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" ], "description": "Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request." }, "delete": { "id": "compute.globalOrganizationOperations.delete", "path": "locations/global/operations/{operation}", "apiVersion": "2024-12-01", "flatPath": "locations/global/operations/{operation}", "httpMethod": "DELETE", "parameters": { "operation": { "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "parentId": { "description": "Parent ID for this request.", "location": "query", "type": "string" } }, "parameterOrder": [ "operation" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified Operations resource." } } }, "zoneOperations": { "methods": { "list": { "id": "compute.zoneOperations.list", "path": "projects/{project}/zones/{zone}/operations", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/operations", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "Name of the zone for request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "OperationList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of Operation resources contained within the specified zone." }, "get": { "id": "compute.zoneOperations.get", "path": "projects/{project}/zones/{zone}/operations/{operation}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/operations/{operation}", "httpMethod": "GET", "parameters": { "operation": { "description": "Name of the Operations resource to return, or its unique numeric identifier.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Retrieves the specified zone-specific Operations resource." }, "wait": { "id": "compute.zoneOperations.wait", "path": "projects/{project}/zones/{zone}/operations/{operation}/wait", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/operations/{operation}/wait", "httpMethod": "POST", "parameters": { "operation": { "description": "Name of the Operations resource to return, or its unique numeric identifier.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. " }, "delete": { "id": "compute.zoneOperations.delete", "path": "projects/{project}/zones/{zone}/operations/{operation}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/operations/{operation}", "httpMethod": "DELETE", "parameters": { "operation": { "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "operation" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified zone-specific Operations resource." } } }, "regionOperations": { "methods": { "list": { "id": "compute.regionOperations.list", "path": "projects/{project}/regions/{region}/operations", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/operations", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "OperationList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of Operation resources contained within the specified region." }, "get": { "id": "compute.regionOperations.get", "path": "projects/{project}/regions/{region}/operations/{operation}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/operations/{operation}", "httpMethod": "GET", "parameters": { "operation": { "description": "Name of the Operations resource to return, or its unique numeric identifier.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Retrieves the specified region-specific Operations resource." }, "wait": { "id": "compute.regionOperations.wait", "path": "projects/{project}/regions/{region}/operations/{operation}/wait", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/operations/{operation}/wait", "httpMethod": "POST", "parameters": { "operation": { "description": "Name of the Operations resource to return, or its unique numeric identifier.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. " }, "delete": { "id": "compute.regionOperations.delete", "path": "projects/{project}/regions/{region}/operations/{operation}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/operations/{operation}", "httpMethod": "DELETE", "parameters": { "operation": { "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "operation" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified region-specific Operations resource." } } }, "acceleratorTypes": { "methods": { "list": { "id": "compute.acceleratorTypes.list", "path": "projects/{project}/zones/{zone}/acceleratorTypes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/acceleratorTypes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "AcceleratorTypeList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of accelerator types that are available to the specified project." }, "aggregatedList": { "id": "compute.acceleratorTypes.aggregatedList", "path": "projects/{project}/aggregated/acceleratorTypes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/acceleratorTypes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "AcceleratorTypeAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of accelerator types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.acceleratorTypes.get", "path": "projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}", "httpMethod": "GET", "parameters": { "acceleratorType": { "description": "Name of the accelerator type to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the specified accelerator type." } } }, "globalAddresses": { "methods": { "list": { "id": "compute.globalAddresses.list", "path": "projects/{project}/global/addresses", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/addresses", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "AddressList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of global addresses." }, "get": { "id": "compute.globalAddresses.get", "path": "projects/{project}/global/addresses/{address}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/addresses/{address}", "httpMethod": "GET", "parameters": { "address": { "description": "Name of the address resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified address resource." }, "insert": { "id": "compute.globalAddresses.insert", "path": "projects/{project}/global/addresses", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/addresses", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "Address" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates an address resource in the specified project by using the data included in the request." }, "delete": { "id": "compute.globalAddresses.delete", "path": "projects/{project}/global/addresses/{address}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/addresses/{address}", "httpMethod": "DELETE", "parameters": { "address": { "description": "Name of the address resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "address" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified address resource." }, "move": { "id": "compute.globalAddresses.move", "path": "projects/{project}/global/addresses/{address}/move", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/addresses/{address}/move", "httpMethod": "POST", "parameters": { "address": { "description": "Name of the address resource to move.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Source project ID which the Address is moved from.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "address" ], "request": { "$ref": "GlobalAddressesMoveRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Moves the specified address resource from one project to another project." }, "setLabels": { "id": "compute.globalAddresses.setLabels", "path": "projects/{project}/global/addresses/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/addresses/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation." } } }, "addresses": { "methods": { "list": { "id": "compute.addresses.list", "path": "projects/{project}/regions/{region}/addresses", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/addresses", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "AddressList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of addresses contained within the specified region." }, "aggregatedList": { "id": "compute.addresses.aggregatedList", "path": "projects/{project}/aggregated/addresses", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/addresses", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "AddressAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of addresses. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.addresses.get", "path": "projects/{project}/regions/{region}/addresses/{address}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/addresses/{address}", "httpMethod": "GET", "parameters": { "address": { "description": "Name of the address resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified address resource." }, "insert": { "id": "compute.addresses.insert", "path": "projects/{project}/regions/{region}/addresses", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/addresses", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "Address" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates an address resource in the specified project by using the data included in the request." }, "delete": { "id": "compute.addresses.delete", "path": "projects/{project}/regions/{region}/addresses/{address}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/addresses/{address}", "httpMethod": "DELETE", "parameters": { "address": { "description": "Name of the address resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "address" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified address resource." }, "move": { "id": "compute.addresses.move", "path": "projects/{project}/regions/{region}/addresses/{address}/move", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/addresses/{address}/move", "httpMethod": "POST", "parameters": { "address": { "description": "Name of the address resource to move.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Source project ID which the Address is moved from.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "address" ], "request": { "$ref": "RegionAddressesMoveRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Moves the specified address resource." }, "setLabels": { "id": "compute.addresses.setLabels", "path": "projects/{project}/regions/{region}/addresses/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/addresses/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation." } } }, "images": { "methods": { "list": { "id": "compute.images.list", "path": "projects/{project}/global/images", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/images", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "ImageList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud." }, "get": { "id": "compute.images.get", "path": "projects/{project}/global/images/{image}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/images/{image}", "httpMethod": "GET", "parameters": { "image": { "description": "Name of the image resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified image." }, "getFromFamily": { "id": "compute.images.getFromFamily", "path": "projects/{project}/global/images/family/{family}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/images/family/{family}", "httpMethod": "GET", "parameters": { "family": { "description": "Name of the image family to search for.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "The image project that the image belongs to. For example, to get a CentOS image, specify centos-cloud as the image project.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the latest image that is part of an image family and is not deprecated. For more information on image families, see Public image families documentation." }, "insert": { "id": "compute.images.insert", "path": "projects/{project}/global/images", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/images", "httpMethod": "POST", "parameters": { "forceCreate": { "description": "Force image creation if true.", "location": "query", "type": "boolean" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "Image" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/devstorage.full_control", "https://www.googleapis.com/auth/devstorage.read_only", "https://www.googleapis.com/auth/devstorage.read_write" ], "description": "Creates an image in the specified project using the data included in the request." }, "setLabels": { "id": "compute.images.setLabels", "path": "projects/{project}/global/images/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/images/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation." }, "delete": { "id": "compute.images.delete", "path": "projects/{project}/global/images/{image}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/images/{image}", "httpMethod": "DELETE", "parameters": { "image": { "description": "Name of the image resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "image" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified image." }, "deprecate": { "id": "compute.images.deprecate", "path": "projects/{project}/global/images/{image}/deprecate", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/images/{image}/deprecate", "httpMethod": "POST", "parameters": { "image": { "description": "Image name.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "image" ], "request": { "$ref": "DeprecationStatus" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead." }, "getIamPolicy": { "id": "compute.images.getIamPolicy", "path": "projects/{project}/global/images/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/images/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "patch": { "id": "compute.images.patch", "path": "projects/{project}/global/images/{image}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/images/{image}", "httpMethod": "PATCH", "parameters": { "image": { "description": "Name of the image resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "image" ], "request": { "$ref": "Image" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status." }, "setIamPolicy": { "id": "compute.images.setIamPolicy", "path": "projects/{project}/global/images/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/images/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.images.testIamPermissions", "path": "projects/{project}/global/images/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/images/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "imageFamilyViews": { "methods": { "get": { "id": "compute.imageFamilyViews.get", "path": "projects/{project}/zones/{zone}/imageFamilyViews/{family}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/imageFamilyViews/{family}", "httpMethod": "GET", "parameters": { "family": { "description": "Name of the image family to search for.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone." } } }, "snapshots": { "methods": { "list": { "id": "compute.snapshots.list", "path": "projects/{project}/global/snapshots", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/snapshots", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "SnapshotList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of Snapshot resources contained within the specified project." }, "get": { "id": "compute.snapshots.get", "path": "projects/{project}/global/snapshots/{snapshot}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/snapshots/{snapshot}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "snapshot": { "description": "Name of the Snapshot resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified Snapshot resource." }, "insert": { "id": "compute.snapshots.insert", "path": "projects/{project}/global/snapshots", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/snapshots", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "Snapshot" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project." }, "setLabels": { "id": "compute.snapshots.setLabels", "path": "projects/{project}/global/snapshots/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/snapshots/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation." }, "delete": { "id": "compute.snapshots.delete", "path": "projects/{project}/global/snapshots/{snapshot}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/snapshots/{snapshot}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "snapshot": { "description": "Name of the Snapshot resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "snapshot" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots." }, "getIamPolicy": { "id": "compute.snapshots.getIamPolicy", "path": "projects/{project}/global/snapshots/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/snapshots/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.snapshots.setIamPolicy", "path": "projects/{project}/global/snapshots/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/snapshots/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.snapshots.testIamPermissions", "path": "projects/{project}/global/snapshots/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/snapshots/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "disks": { "methods": { "list": { "id": "compute.disks.list", "path": "projects/{project}/zones/{zone}/disks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "DiskList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of persistent disks contained within the specified zone." }, "aggregatedList": { "id": "compute.disks.aggregatedList", "path": "projects/{project}/aggregated/disks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/disks", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "DiskAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of persistent disks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.disks.get", "path": "projects/{project}/zones/{zone}/disks/{disk}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}", "httpMethod": "GET", "parameters": { "disk": { "description": "Name of the persistent disk to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the specified persistent disk." }, "insert": { "id": "compute.disks.insert", "path": "projects/{project}/zones/{zone}/disks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "Disk" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property." }, "setLabels": { "id": "compute.disks.setLabels", "path": "projects/{project}/zones/{zone}/disks/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "request": { "$ref": "ZoneSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation." }, "delete": { "id": "compute.disks.delete", "path": "projects/{project}/zones/{zone}/disks/{disk}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}", "httpMethod": "DELETE", "parameters": { "disk": { "description": "Name of the persistent disk to delete.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "disk" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots." }, "createSnapshot": { "id": "compute.disks.createSnapshot", "path": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot", "httpMethod": "POST", "parameters": { "disk": { "description": "Name of the persistent disk to snapshot.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "guestFlush": { "description": "[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.", "location": "query", "type": "boolean" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "disk" ], "request": { "$ref": "Snapshot" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project." }, "resize": { "id": "compute.disks.resize", "path": "projects/{project}/zones/{zone}/disks/{disk}/resize", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/resize", "httpMethod": "POST", "parameters": { "disk": { "description": "The name of the persistent disk.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "disk" ], "request": { "$ref": "DisksResizeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Resizes the specified persistent disk. You can only increase the size of the disk." }, "addResourcePolicies": { "id": "compute.disks.addResourcePolicies", "path": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies", "httpMethod": "POST", "parameters": { "disk": { "description": "The disk name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "disk" ], "request": { "$ref": "DisksAddResourcePoliciesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation." }, "removeResourcePolicies": { "id": "compute.disks.removeResourcePolicies", "path": "projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies", "httpMethod": "POST", "parameters": { "disk": { "description": "The disk name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "disk" ], "request": { "$ref": "DisksRemoveResourcePoliciesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Removes resource policies from a disk." }, "getIamPolicy": { "id": "compute.disks.getIamPolicy", "path": "projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.disks.setIamPolicy", "path": "projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "request": { "$ref": "ZoneSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.disks.testIamPermissions", "path": "projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." }, "update": { "id": "compute.disks.update", "path": "projects/{project}/zones/{zone}/disks/{disk}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}", "httpMethod": "PATCH", "parameters": { "disk": { "description": "The disk name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "updateMask": { "description": "update_mask indicates fields to be updated as part of this request.", "location": "query", "type": "string", "format": "google-fieldmask" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "disk" ], "request": { "$ref": "Disk" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license." }, "startAsyncReplication": { "id": "compute.disks.startAsyncReplication", "path": "projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication", "httpMethod": "POST", "parameters": { "disk": { "description": "The name of the persistent disk.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "disk" ], "request": { "$ref": "DisksStartAsyncReplicationRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Starts asynchronous replication. Must be invoked on the primary disk." }, "stopAsyncReplication": { "id": "compute.disks.stopAsyncReplication", "path": "projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication", "httpMethod": "POST", "parameters": { "disk": { "description": "The name of the persistent disk.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "disk" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk." }, "stopGroupAsyncReplication": { "id": "compute.disks.stopGroupAsyncReplication", "path": "projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request. This must be the zone of the primary or secondary disks in the consistency group.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "DisksStopGroupAsyncReplicationResource" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope." }, "bulkInsert": { "id": "compute.disks.bulkInsert", "path": "projects/{project}/zones/{zone}/disks/bulkInsert", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/disks/bulkInsert", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "BulkInsertDiskResource" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Bulk create a set of disks." } } }, "regionDisks": { "methods": { "list": { "id": "compute.regionDisks.list", "path": "projects/{project}/regions/{region}/disks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "DiskList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of persistent disks contained within the specified region." }, "get": { "id": "compute.regionDisks.get", "path": "projects/{project}/regions/{region}/disks/{disk}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/{disk}", "httpMethod": "GET", "parameters": { "disk": { "description": "Name of the regional persistent disk to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns a specified regional persistent disk." }, "insert": { "id": "compute.regionDisks.insert", "path": "projects/{project}/regions/{region}/disks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "sourceImage": { "description": "Source image to restore onto a disk. This field is optional.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "Disk" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a persistent regional disk in the specified project using the data included in the request." }, "setLabels": { "id": "compute.regionDisks.setLabels", "path": "projects/{project}/regions/{region}/disks/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on the target regional disk." }, "delete": { "id": "compute.regionDisks.delete", "path": "projects/{project}/regions/{region}/disks/{disk}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/{disk}", "httpMethod": "DELETE", "parameters": { "disk": { "description": "Name of the regional persistent disk to delete.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "disk" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots." }, "createSnapshot": { "id": "compute.regionDisks.createSnapshot", "path": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot", "httpMethod": "POST", "parameters": { "disk": { "description": "Name of the regional persistent disk to snapshot.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "disk" ], "request": { "$ref": "Snapshot" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project." }, "resize": { "id": "compute.regionDisks.resize", "path": "projects/{project}/regions/{region}/disks/{disk}/resize", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/{disk}/resize", "httpMethod": "POST", "parameters": { "disk": { "description": "Name of the regional persistent disk.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "The project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "disk" ], "request": { "$ref": "RegionDisksResizeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Resizes the specified regional persistent disk." }, "addResourcePolicies": { "id": "compute.regionDisks.addResourcePolicies", "path": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies", "httpMethod": "POST", "parameters": { "disk": { "description": "The disk name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "disk" ], "request": { "$ref": "RegionDisksAddResourcePoliciesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation." }, "removeResourcePolicies": { "id": "compute.regionDisks.removeResourcePolicies", "path": "projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies", "httpMethod": "POST", "parameters": { "disk": { "description": "The disk name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "disk" ], "request": { "$ref": "RegionDisksRemoveResourcePoliciesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Removes resource policies from a regional disk." }, "getIamPolicy": { "id": "compute.regionDisks.getIamPolicy", "path": "projects/{project}/regions/{region}/disks/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.regionDisks.setIamPolicy", "path": "projects/{project}/regions/{region}/disks/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.regionDisks.testIamPermissions", "path": "projects/{project}/regions/{region}/disks/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." }, "update": { "id": "compute.regionDisks.update", "path": "projects/{project}/regions/{region}/disks/{disk}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/{disk}", "httpMethod": "PATCH", "parameters": { "disk": { "description": "The disk name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "updateMask": { "description": "update_mask indicates fields to be updated as part of this request.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "project", "region", "disk" ], "request": { "$ref": "Disk" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license." }, "startAsyncReplication": { "id": "compute.regionDisks.startAsyncReplication", "path": "projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication", "httpMethod": "POST", "parameters": { "disk": { "description": "The name of the persistent disk.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "disk" ], "request": { "$ref": "RegionDisksStartAsyncReplicationRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Starts asynchronous replication. Must be invoked on the primary disk." }, "stopAsyncReplication": { "id": "compute.regionDisks.stopAsyncReplication", "path": "projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication", "httpMethod": "POST", "parameters": { "disk": { "description": "The name of the persistent disk.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "disk" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Stops asynchronous replication. Can be invoked either on the primary or on the secondary disk." }, "stopGroupAsyncReplication": { "id": "compute.regionDisks.stopGroupAsyncReplication", "path": "projects/{project}/regions/{region}/disks/stopGroupAsyncReplication", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/stopGroupAsyncReplication", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request. This must be the region of the primary or secondary disks in the consistency group.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "DisksStopGroupAsyncReplicationResource" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Stops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope." }, "bulkInsert": { "id": "compute.regionDisks.bulkInsert", "path": "projects/{project}/regions/{region}/disks/bulkInsert", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/disks/bulkInsert", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "BulkInsertDiskResource" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Bulk create a set of disks." } } }, "firewalls": { "methods": { "list": { "id": "compute.firewalls.list", "path": "projects/{project}/global/firewalls", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewalls", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "FirewallList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of firewall rules available to the specified project." }, "get": { "id": "compute.firewalls.get", "path": "projects/{project}/global/firewalls/{firewall}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewalls/{firewall}", "httpMethod": "GET", "parameters": { "firewall": { "description": "Name of the firewall rule to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified firewall." }, "insert": { "id": "compute.firewalls.insert", "path": "projects/{project}/global/firewalls", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewalls", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "Firewall" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a firewall rule in the specified project using the data included in the request." }, "delete": { "id": "compute.firewalls.delete", "path": "projects/{project}/global/firewalls/{firewall}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewalls/{firewall}", "httpMethod": "DELETE", "parameters": { "firewall": { "description": "Name of the firewall rule to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewall" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified firewall." }, "update": { "id": "compute.firewalls.update", "path": "projects/{project}/global/firewalls/{firewall}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewalls/{firewall}", "httpMethod": "PUT", "parameters": { "firewall": { "description": "Name of the firewall rule to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewall" ], "request": { "$ref": "Firewall" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead." }, "patch": { "id": "compute.firewalls.patch", "path": "projects/{project}/global/firewalls/{firewall}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewalls/{firewall}", "httpMethod": "PATCH", "parameters": { "firewall": { "description": "Name of the firewall rule to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewall" ], "request": { "$ref": "Firewall" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." } } }, "firewallPolicies": { "methods": { "list": { "id": "compute.firewallPolicies.list", "path": "locations/global/firewallPolicies", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "parentId": { "description": "Parent ID for this request. The ID can be either be \"folders\/[FOLDER_ID]\" if the parent is a folder or \"organizations\/[ORGANIZATION_ID]\" if the parent is an organization.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "response": { "$ref": "FirewallPolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all the policies that have been configured for the specified folder or organization." }, "get": { "id": "compute.firewallPolicies.get", "path": "locations/global/firewallPolicies/{firewallPolicy}", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}", "httpMethod": "GET", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to get.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "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" ], "description": "Returns the specified firewall policy." }, "insert": { "id": "compute.firewallPolicies.insert", "path": "locations/global/firewallPolicies", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies", "httpMethod": "POST", "parameters": { "parentId": { "description": "Parent ID for this request. The ID can be either be \"folders\/[FOLDER_ID]\" if the parent is a folder or \"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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "request": { "$ref": "FirewallPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a new policy in the specified project using the data included in the request." }, "delete": { "id": "compute.firewallPolicies.delete", "path": "locations/global/firewallPolicies/{firewallPolicy}", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}", "httpMethod": "DELETE", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to delete.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified policy." }, "patch": { "id": "compute.firewallPolicies.patch", "path": "locations/global/firewallPolicies/{firewallPolicy}", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}", "httpMethod": "PATCH", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "firewallPolicy" ], "request": { "$ref": "FirewallPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified policy with the data included in the request." }, "getRule": { "id": "compute.firewallPolicies.getRule", "path": "locations/global/firewallPolicies/{firewallPolicy}/getRule", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getRule", "httpMethod": "GET", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to which the queried rule belongs.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" }, "priority": { "description": "The priority of the rule to get from the firewall policy.", "location": "query", "type": "integer", "format": "int32" } }, "parameterOrder": [ "firewallPolicy" ], "response": { "$ref": "FirewallPolicyRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets a rule of the specified priority." }, "addRule": { "id": "compute.firewallPolicies.addRule", "path": "locations/global/firewallPolicies/{firewallPolicy}/addRule", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addRule", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "firewallPolicy" ], "request": { "$ref": "FirewallPolicyRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Inserts a rule into a firewall policy." }, "removeRule": { "id": "compute.firewallPolicies.removeRule", "path": "locations/global/firewallPolicies/{firewallPolicy}/removeRule", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeRule", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" }, "priority": { "description": "The priority of the rule to remove from the firewall policy.", "location": "query", "type": "integer", "format": "int32" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes a rule of the specified priority." }, "patchRule": { "id": "compute.firewallPolicies.patchRule", "path": "locations/global/firewallPolicies/{firewallPolicy}/patchRule", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/patchRule", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" }, "priority": { "description": "The priority of the rule to patch.", "location": "query", "type": "integer", "format": "int32" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "firewallPolicy" ], "request": { "$ref": "FirewallPolicyRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches a rule of the specified priority." }, "addAssociation": { "id": "compute.firewallPolicies.addAssociation", "path": "locations/global/firewallPolicies/{firewallPolicy}/addAssociation", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addAssociation", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" }, "replaceExistingAssociation": { "description": "Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.", "location": "query", "type": "boolean" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "firewallPolicy" ], "request": { "$ref": "FirewallPolicyAssociation" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Inserts an association for the specified firewall policy." }, "removeAssociation": { "id": "compute.firewallPolicies.removeAssociation", "path": "locations/global/firewallPolicies/{firewallPolicy}/removeAssociation", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeAssociation", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Removes an association for the specified firewall policy." }, "listAssociations": { "id": "compute.firewallPolicies.listAssociations", "path": "locations/global/firewallPolicies/listAssociations", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/listAssociations", "httpMethod": "GET", "parameters": { "targetResource": { "description": "The target resource to list associations. It is an organization, or a folder.", "location": "query", "type": "string" } }, "response": { "$ref": "FirewallPoliciesListAssociationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists associations of a specified target, i.e., organization or folder." }, "getAssociation": { "id": "compute.firewallPolicies.getAssociation", "path": "locations/global/firewallPolicies/{firewallPolicy}/getAssociation", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getAssociation", "httpMethod": "GET", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to which the queried rule belongs.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" }, "name": { "description": "The name of the association to get from the firewall policy.", "location": "query", "type": "string" } }, "parameterOrder": [ "firewallPolicy" ], "response": { "$ref": "FirewallPolicyAssociation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets an association with the specified name." }, "cloneRules": { "id": "compute.firewallPolicies.cloneRules", "path": "locations/global/firewallPolicies/{firewallPolicy}/cloneRules", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/cloneRules", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "sourceFirewallPolicy": { "description": "The firewall policy from which to copy rules.", "location": "query", "type": "string" } }, "parameterOrder": [ "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Copies rules to the specified firewall policy." }, "move": { "id": "compute.firewallPolicies.move", "path": "locations/global/firewallPolicies/{firewallPolicy}/move", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/move", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" }, "parentId": { "description": "The new parent of the firewall policy. The ID can be either be \"folders\/[FOLDER_ID]\" if the parent is a folder or \"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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Moves the specified firewall policy." }, "getIamPolicy": { "id": "compute.firewallPolicies.getIamPolicy", "path": "locations/global/firewallPolicies/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.firewallPolicies.setIamPolicy", "path": "locations/global/firewallPolicies/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "resource": { "description": "Name or id of the resource for this request.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "resource" ], "request": { "$ref": "GlobalOrganizationSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.firewallPolicies.testIamPermissions", "path": "locations/global/firewallPolicies/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "locations/global/firewallPolicies/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "resource": { "description": "Name or id of the resource for this request.", "pattern": "(firewallPolicies\/)?[0-9]{0,20}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "networkFirewallPolicies": { "methods": { "list": { "id": "compute.networkFirewallPolicies.list", "path": "projects/{project}/global/firewallPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "FirewallPolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all the policies that have been configured for the specified project." }, "get": { "id": "compute.networkFirewallPolicies.get", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}", "httpMethod": "GET", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to get.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified network firewall policy." }, "insert": { "id": "compute.networkFirewallPolicies.insert", "path": "projects/{project}/global/firewallPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "FirewallPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a new policy in the specified project using the data included in the request." }, "delete": { "id": "compute.networkFirewallPolicies.delete", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}", "httpMethod": "DELETE", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified policy." }, "patch": { "id": "compute.networkFirewallPolicies.patch", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}", "httpMethod": "PATCH", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "request": { "$ref": "FirewallPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified policy with the data included in the request." }, "getRule": { "id": "compute.networkFirewallPolicies.getRule", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule", "httpMethod": "GET", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to which the queried rule belongs.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "priority": { "description": "The priority of the rule to get from the firewall policy.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "response": { "$ref": "FirewallPolicyRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets a rule of the specified priority." }, "getPacketMirroringRule": { "id": "compute.networkFirewallPolicies.getPacketMirroringRule", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", "httpMethod": "GET", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to which the queried rule belongs.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "priority": { "description": "The priority of the rule to get from the firewall policy.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "response": { "$ref": "FirewallPolicyRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets a packet mirroring rule of the specified priority." }, "addRule": { "id": "compute.networkFirewallPolicies.addRule", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "maxPriority": { "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", "location": "query", "type": "integer", "format": "int32" }, "minPriority": { "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "request": { "$ref": "FirewallPolicyRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Inserts a rule into a firewall policy." }, "addPacketMirroringRule": { "id": "compute.networkFirewallPolicies.addPacketMirroringRule", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "maxPriority": { "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", "location": "query", "type": "integer", "format": "int32" }, "minPriority": { "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "request": { "$ref": "FirewallPolicyRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Inserts a packet mirroring rule into a firewall policy." }, "removeRule": { "id": "compute.networkFirewallPolicies.removeRule", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "priority": { "description": "The priority of the rule to remove from the firewall policy.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes a rule of the specified priority." }, "removePacketMirroringRule": { "id": "compute.networkFirewallPolicies.removePacketMirroringRule", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "priority": { "description": "The priority of the rule to remove from the firewall policy.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes a packet mirroring rule of the specified priority." }, "patchRule": { "id": "compute.networkFirewallPolicies.patchRule", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "priority": { "description": "The priority of the rule to patch.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "request": { "$ref": "FirewallPolicyRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches a rule of the specified priority." }, "patchPacketMirroringRule": { "id": "compute.networkFirewallPolicies.patchPacketMirroringRule", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "priority": { "description": "The priority of the rule to patch.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "request": { "$ref": "FirewallPolicyRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches a packet mirroring rule of the specified priority." }, "getIamPolicy": { "id": "compute.networkFirewallPolicies.getIamPolicy", "path": "projects/{project}/global/firewallPolicies/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.networkFirewallPolicies.setIamPolicy", "path": "projects/{project}/global/firewallPolicies/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.networkFirewallPolicies.testIamPermissions", "path": "projects/{project}/global/firewallPolicies/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." }, "addAssociation": { "id": "compute.networkFirewallPolicies.addAssociation", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "replaceExistingAssociation": { "description": "Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.", "location": "query", "type": "boolean" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "request": { "$ref": "FirewallPolicyAssociation" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Inserts an association for the specified firewall policy." }, "removeAssociation": { "id": "compute.networkFirewallPolicies.removeAssociation", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Removes an association for the specified firewall policy." }, "getAssociation": { "id": "compute.networkFirewallPolicies.getAssociation", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation", "httpMethod": "GET", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to which the queried association belongs.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "response": { "$ref": "FirewallPolicyAssociation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets an association with the specified name." }, "cloneRules": { "id": "compute.networkFirewallPolicies.cloneRules", "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "sourceFirewallPolicy": { "description": "The firewall policy from which to copy rules.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Copies rules to the specified firewall policy." }, "aggregatedList": { "id": "compute.networkFirewallPolicies.aggregatedList", "path": "projects/{project}/aggregated/firewallPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/firewallPolicies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "NetworkFirewallPolicyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of network firewall policies, listing network firewall policies from all applicable scopes (global and regional) and grouping the results per scope. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." } } }, "regionNetworkFirewallPolicies": { "methods": { "list": { "id": "compute.regionNetworkFirewallPolicies.list", "path": "projects/{project}/regions/{region}/firewallPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "FirewallPolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all the network firewall policies that have been configured for the specified project in the given region." }, "get": { "id": "compute.regionNetworkFirewallPolicies.get", "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}", "httpMethod": "GET", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to get.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified network firewall policy." }, "insert": { "id": "compute.regionNetworkFirewallPolicies.insert", "path": "projects/{project}/regions/{region}/firewallPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "FirewallPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a new network firewall policy in the specified project and region." }, "delete": { "id": "compute.regionNetworkFirewallPolicies.delete", "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}", "httpMethod": "DELETE", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified network firewall policy." }, "patch": { "id": "compute.regionNetworkFirewallPolicies.patch", "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}", "httpMethod": "PATCH", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "firewallPolicy" ], "request": { "$ref": "FirewallPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified network firewall policy." }, "getRule": { "id": "compute.regionNetworkFirewallPolicies.getRule", "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule", "httpMethod": "GET", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to which the queried rule belongs.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "priority": { "description": "The priority of the rule to get from the firewall policy.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "firewallPolicy" ], "response": { "$ref": "FirewallPolicyRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets a rule of the specified priority." }, "addRule": { "id": "compute.regionNetworkFirewallPolicies.addRule", "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "maxPriority": { "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", "location": "query", "type": "integer", "format": "int32" }, "minPriority": { "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "firewallPolicy" ], "request": { "$ref": "FirewallPolicyRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Inserts a rule into a network firewall policy." }, "removeRule": { "id": "compute.regionNetworkFirewallPolicies.removeRule", "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "priority": { "description": "The priority of the rule to remove from the firewall policy.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes a rule of the specified priority." }, "patchRule": { "id": "compute.regionNetworkFirewallPolicies.patchRule", "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "priority": { "description": "The priority of the rule to patch.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "firewallPolicy" ], "request": { "$ref": "FirewallPolicyRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches a rule of the specified priority." }, "cloneRules": { "id": "compute.regionNetworkFirewallPolicies.cloneRules", "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "sourceFirewallPolicy": { "description": "The firewall policy from which to copy rules.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Copies rules to the specified network firewall policy." }, "getAssociation": { "id": "compute.regionNetworkFirewallPolicies.getAssociation", "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation", "httpMethod": "GET", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to which the queried association belongs.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "firewallPolicy" ], "response": { "$ref": "FirewallPolicyAssociation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets an association with the specified name." }, "addAssociation": { "id": "compute.regionNetworkFirewallPolicies.addAssociation", "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "replaceExistingAssociation": { "description": "Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists.", "location": "query", "type": "boolean" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "firewallPolicy" ], "request": { "$ref": "FirewallPolicyAssociation" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Inserts an association for the specified network firewall policy." }, "removeAssociation": { "id": "compute.regionNetworkFirewallPolicies.removeAssociation", "path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation", "httpMethod": "POST", "parameters": { "firewallPolicy": { "description": "Name of the firewall policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "firewallPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Removes an association for the specified network firewall policy." }, "getEffectiveFirewalls": { "id": "compute.regionNetworkFirewallPolicies.getEffectiveFirewalls", "path": "projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls", "httpMethod": "GET", "parameters": { "network": { "description": "Network reference", "location": "query", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "network" ], "response": { "$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Returns the effective firewalls on a given network." }, "getIamPolicy": { "id": "compute.regionNetworkFirewallPolicies.getIamPolicy", "path": "projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.regionNetworkFirewallPolicies.setIamPolicy", "path": "projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.regionNetworkFirewallPolicies.testIamPermissions", "path": "projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "securityPolicies": { "methods": { "list": { "id": "compute.securityPolicies.list", "path": "projects/{project}/global/securityPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/securityPolicies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "SecurityPolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "List all the policies that have been configured for the specified project." }, "get": { "id": "compute.securityPolicies.get", "path": "projects/{project}/global/securityPolicies/{securityPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "securityPolicy": { "description": "Name of the security policy to get.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "List all of the ordered rules present in a single specified policy." }, "insert": { "id": "compute.securityPolicies.insert", "path": "projects/{project}/global/securityPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/securityPolicies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { "description": "If true, the request will not be committed.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "request": { "$ref": "SecurityPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a new policy in the specified project using the data included in the request." }, "delete": { "id": "compute.securityPolicies.delete", "path": "projects/{project}/global/securityPolicies/{securityPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "securityPolicy": { "description": "Name of the security policy to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "securityPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified policy." }, "patch": { "id": "compute.securityPolicies.patch", "path": "projects/{project}/global/securityPolicies/{securityPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "securityPolicy": { "description": "Name of the security policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Indicates fields to be cleared as part of this request.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "project", "securityPolicy" ], "request": { "$ref": "SecurityPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead." }, "getRule": { "id": "compute.securityPolicies.getRule", "path": "projects/{project}/global/securityPolicies/{securityPolicy}/getRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/getRule", "httpMethod": "GET", "parameters": { "priority": { "description": "The priority of the rule to get from the security policy.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "securityPolicy": { "description": "Name of the security policy to which the queried rule belongs.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "securityPolicy" ], "response": { "$ref": "SecurityPolicyRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets a rule at the specified priority." }, "addRule": { "id": "compute.securityPolicies.addRule", "path": "projects/{project}/global/securityPolicies/{securityPolicy}/addRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/addRule", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "securityPolicy": { "description": "Name of the security policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "validateOnly": { "description": "If true, the request will not be committed.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "securityPolicy" ], "request": { "$ref": "SecurityPolicyRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Inserts a rule into a security policy." }, "removeRule": { "id": "compute.securityPolicies.removeRule", "path": "projects/{project}/global/securityPolicies/{securityPolicy}/removeRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/removeRule", "httpMethod": "POST", "parameters": { "priority": { "description": "The priority of the rule to remove from the security policy.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "securityPolicy": { "description": "Name of the security policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "securityPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes a rule at the specified priority." }, "patchRule": { "id": "compute.securityPolicies.patchRule", "path": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule", "httpMethod": "POST", "parameters": { "priority": { "description": "The priority of the rule to patch.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "securityPolicy": { "description": "Name of the security policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Indicates fields to be cleared as part of this request.", "location": "query", "type": "string", "format": "google-fieldmask" }, "validateOnly": { "description": "If true, the request will not be committed.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "securityPolicy" ], "request": { "$ref": "SecurityPolicyRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask." }, "listPreconfiguredExpressionSets": { "id": "compute.securityPolicies.listPreconfiguredExpressionSets", "path": "projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "SecurityPoliciesListPreconfiguredExpressionSetsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the current list of preconfigured Web Application Firewall (WAF) expressions." }, "setLabels": { "id": "compute.securityPolicies.setLabels", "path": "projects/{project}/global/securityPolicies/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/securityPolicies/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation." }, "aggregatedList": { "id": "compute.securityPolicies.aggregatedList", "path": "projects/{project}/aggregated/securityPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/securityPolicies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Name of the project scoping this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "SecurityPoliciesAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." } } }, "regionSecurityPolicies": { "methods": { "list": { "id": "compute.regionSecurityPolicies.list", "path": "projects/{project}/regions/{region}/securityPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/securityPolicies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "SecurityPolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "List all the policies that have been configured for the specified project and region." }, "get": { "id": "compute.regionSecurityPolicies.get", "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "securityPolicy": { "description": "Name of the security policy to get.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "List all of the ordered rules present in a single specified policy." }, "insert": { "id": "compute.regionSecurityPolicies.insert", "path": "projects/{project}/regions/{region}/securityPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/securityPolicies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { "description": "If true, the request will not be committed.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "SecurityPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a new policy in the specified project using the data included in the request." }, "delete": { "id": "compute.regionSecurityPolicies.delete", "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "securityPolicy": { "description": "Name of the security policy to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "securityPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified policy." }, "patch": { "id": "compute.regionSecurityPolicies.patch", "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "securityPolicy": { "description": "Name of the security policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Indicates fields to be cleared as part of this request.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "project", "region", "securityPolicy" ], "request": { "$ref": "SecurityPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead." }, "getRule": { "id": "compute.regionSecurityPolicies.getRule", "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", "httpMethod": "GET", "parameters": { "priority": { "description": "The priority of the rule to get from the security policy.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "securityPolicy": { "description": "Name of the security policy to which the queried rule belongs.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "securityPolicy" ], "response": { "$ref": "SecurityPolicyRule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets a rule at the specified priority." }, "addRule": { "id": "compute.regionSecurityPolicies.addRule", "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "securityPolicy": { "description": "Name of the security policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "validateOnly": { "description": "If true, the request will not be committed.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region", "securityPolicy" ], "request": { "$ref": "SecurityPolicyRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Inserts a rule into a security policy." }, "removeRule": { "id": "compute.regionSecurityPolicies.removeRule", "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", "httpMethod": "POST", "parameters": { "priority": { "description": "The priority of the rule to remove from the security policy.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "securityPolicy": { "description": "Name of the security policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "securityPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes a rule at the specified priority." }, "patchRule": { "id": "compute.regionSecurityPolicies.patchRule", "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", "httpMethod": "POST", "parameters": { "priority": { "description": "The priority of the rule to patch.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "securityPolicy": { "description": "Name of the security policy to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Indicates fields to be cleared as part of this request.", "location": "query", "type": "string", "format": "google-fieldmask" }, "validateOnly": { "description": "If true, the request will not be committed.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region", "securityPolicy" ], "request": { "$ref": "SecurityPolicyRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask." }, "setLabels": { "id": "compute.regionSecurityPolicies.setLabels", "path": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation." } } }, "instances": { "methods": { "list": { "id": "compute.instances.list", "path": "projects/{project}/zones/{zone}/instances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "InstanceList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of instances contained within the specified zone." }, "aggregatedList": { "id": "compute.instances.aggregatedList", "path": "projects/{project}/aggregated/instances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/instances", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "InstanceAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "listReferrers": { "id": "compute.instances.listReferrers", "path": "projects/{project}/zones/{zone}/instances/{instance}/referrers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/referrers", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "instance": { "description": "Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.", "pattern": "-\|[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "response": { "$ref": "InstanceListReferrers" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances." }, "get": { "id": "compute.instances.get", "path": "projects/{project}/zones/{zone}/instances/{instance}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}", "httpMethod": "GET", "parameters": { "instance": { "description": "Name of the instance resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the specified Instance resource." }, "insert": { "id": "compute.instances.insert", "path": "projects/{project}/zones/{zone}/instances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "sourceInstanceTemplate": { "description": "Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project \/global\/instanceTemplates\/instanceTemplate - projects\/project\/global\/instanceTemplates\/instanceTemplate - global\/instanceTemplates\/instanceTemplate ", "location": "query", "type": "string" }, "sourceMachineImage": { "description": "Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https:\/\/www.googleapis.com\/compute\/v1\/projects\/project\/global\/global \/machineImages\/machineImage - projects\/project\/global\/global\/machineImages\/machineImage - global\/machineImages\/machineImage ", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "Instance" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates an instance resource in the specified project using the data included in the request." }, "delete": { "id": "compute.instances.delete", "path": "projects/{project}/zones/{zone}/instances/{instance}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}", "httpMethod": "DELETE", "parameters": { "instance": { "description": "Name of the instance resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified Instance resource. For more information, see Deleting an instance." }, "reset": { "id": "compute.instances.reset", "path": "projects/{project}/zones/{zone}/instances/{instance}/reset", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reset", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance." }, "simulateMaintenanceEvent": { "id": "compute.instances.simulateMaintenanceEvent", "path": "projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "withExtendedNotifications": { "description": "Determines whether the customers receive notifications before migration. Only applicable to SF vms.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event." }, "performMaintenance": { "id": "compute.instances.performMaintenance", "path": "projects/{project}/zones/{zone}/instances/{instance}/performMaintenance", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/performMaintenance", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Perform a manual maintenance on the instance." }, "reportHostAsFaulty": { "id": "compute.instances.reportHostAsFaulty", "path": "projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "InstancesReportHostAsFaultyRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Mark the host as faulty and try to restart the instance on a new host." }, "addAccessConfig": { "id": "compute.instances.addAccessConfig", "path": "projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig", "httpMethod": "POST", "parameters": { "instance": { "description": "The instance name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance", "networkInterface" ], "request": { "$ref": "AccessConfig" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Adds an access config to an instance's network interface." }, "deleteAccessConfig": { "id": "compute.instances.deleteAccessConfig", "path": "projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig", "httpMethod": "POST", "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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance", "accessConfig", "networkInterface" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes an access config from an instance's network interface." }, "updateAccessConfig": { "id": "compute.instances.updateAccessConfig", "path": "projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig", "httpMethod": "POST", "parameters": { "instance": { "description": "The instance name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance", "networkInterface" ], "request": { "$ref": "AccessConfig" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." }, "updateNetworkInterface": { "id": "compute.instances.updateNetworkInterface", "path": "projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface", "httpMethod": "PATCH", "parameters": { "instance": { "description": "The instance name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance", "networkInterface" ], "request": { "$ref": "NetworkInterface" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics." }, "setScheduling": { "id": "compute.instances.setScheduling", "path": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling", "httpMethod": "POST", "parameters": { "instance": { "description": "Instance name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "Scheduling" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy." }, "getSerialPortOutput": { "id": "compute.instances.getSerialPortOutput", "path": "projects/{project}/zones/{zone}/instances/{instance}/serialPort", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/serialPort", "httpMethod": "GET", "parameters": { "instance": { "description": "Name of the instance for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "port": { "description": "Specifies which COM or serial port to retrieve data from.", "default": "1", "minimum": "1", "maximum": "4", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "start": { "description": "Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`. If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value. You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console. Note that the negative start is bounded by the retained buffer size, and the returned serial console output will not exceed the max buffer size.", "location": "query", "type": "string", "format": "int64" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "response": { "$ref": "SerialPortOutput" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Returns the last 1 MB of serial port output from the specified instance." }, "getScreenshot": { "id": "compute.instances.getScreenshot", "path": "projects/{project}/zones/{zone}/instances/{instance}/screenshot", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/screenshot", "httpMethod": "GET", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "response": { "$ref": "Screenshot" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Returns the screenshot from the specified instance." }, "sendDiagnosticInterrupt": { "id": "compute.instances.sendDiagnosticInterrupt", "path": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sends diagnostic interrupt to the instance." }, "getGuestAttributes": { "id": "compute.instances.getGuestAttributes", "path": "projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes", "httpMethod": "GET", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": 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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "response": { "$ref": "GuestAttributes" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Returns the specified guest attributes entry." }, "attachDisk": { "id": "compute.instances.attachDisk", "path": "projects/{project}/zones/{zone}/instances/{instance}/attachDisk", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/attachDisk", "httpMethod": "POST", "parameters": { "forceAttach": { "description": "Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.", "location": "query", "type": "boolean" }, "instance": { "description": "The instance name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "AttachedDisk" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance." }, "detachDisk": { "id": "compute.instances.detachDisk", "path": "projects/{project}/zones/{zone}/instances/{instance}/detachDisk", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/detachDisk", "httpMethod": "POST", "parameters": { "deviceName": { "description": "The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names.", "location": "query", "required": true, "type": "string" }, "instance": { "description": "Instance name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance", "deviceName" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Detaches a disk from an instance." }, "setMachineResources": { "id": "compute.instances.setMachineResources", "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "InstancesSetMachineResourcesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the number and\/or type of accelerator for a stopped instance to the values specified in the request." }, "setMachineType": { "id": "compute.instances.setMachineType", "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "InstancesSetMachineTypeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the machine type for a stopped instance to the machine type specified in the request." }, "setMetadata": { "id": "compute.instances.setMetadata", "path": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "Metadata" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets metadata for the specified instance to the data included in the request." }, "setMinCpuPlatform": { "id": "compute.instances.setMinCpuPlatform", "path": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "InstancesSetMinCpuPlatformRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform." }, "setTags": { "id": "compute.instances.setTags", "path": "projects/{project}/zones/{zone}/instances/{instance}/setTags", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setTags", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "Tags" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets network tags for the specified instance to the data included in the request." }, "setLabels": { "id": "compute.instances.setLabels", "path": "projects/{project}/zones/{zone}/instances/{instance}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setLabels", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "InstancesSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation." }, "setName": { "id": "compute.instances.setName", "path": "projects/{project}/zones/{zone}/instances/{instance}/setName", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setName", "httpMethod": "POST", "parameters": { "instance": { "description": "The instance name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "InstancesSetNameRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets name of an instance." }, "setDiskAutoDelete": { "id": "compute.instances.setDiskAutoDelete", "path": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete", "httpMethod": "POST", "parameters": { "autoDelete": { "description": "Whether to auto-delete the disk when the instance is deleted.", "location": "query", "required": true, "type": "boolean" }, "deviceName": { "description": "The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names.", "pattern": "\\w[\\w.-]{0,254}", "location": "query", "required": true, "type": "string" }, "instance": { "description": "The instance name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance", "autoDelete", "deviceName" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the auto-delete flag for a disk attached to an instance." }, "start": { "id": "compute.instances.start", "path": "projects/{project}/zones/{zone}/instances/{instance}/start", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/start", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance resource to start.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance." }, "startWithEncryptionKey": { "id": "compute.instances.startWithEncryptionKey", "path": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance resource to start.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "InstancesStartWithEncryptionKeyRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance." }, "stop": { "id": "compute.instances.stop", "path": "projects/{project}/zones/{zone}/instances/{instance}/stop", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/stop", "httpMethod": "POST", "parameters": { "discardLocalSsd": { "description": "This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If 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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance." }, "getIamPolicy": { "id": "compute.instances.getIamPolicy", "path": "projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.instances.setIamPolicy", "path": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "request": { "$ref": "ZoneSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.instances.testIamPermissions", "path": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." }, "setServiceAccount": { "id": "compute.instances.setServiceAccount", "path": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance resource to start.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "InstancesSetServiceAccountRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance." }, "setDeletionProtection": { "id": "compute.instances.setDeletionProtection", "path": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection", "httpMethod": "POST", "parameters": { "deletionProtection": { "description": "Whether the resource should be protected against deletion.", "default": "true", "location": "query", "type": "boolean" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets deletion protection on the instance." }, "suspend": { "id": "compute.instances.suspend", "path": "projects/{project}/zones/{zone}/instances/{instance}/suspend", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/suspend", "httpMethod": "POST", "parameters": { "discardLocalSsd": { "description": "This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If 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.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance." }, "resume": { "id": "compute.instances.resume", "path": "projects/{project}/zones/{zone}/instances/{instance}/resume", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/resume", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the instance resource to resume.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Resumes an instance that was suspended using the instances().suspend method." }, "addResourcePolicies": { "id": "compute.instances.addResourcePolicies", "path": "projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies", "httpMethod": "POST", "parameters": { "instance": { "description": "The instance name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "InstancesAddResourcePoliciesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations." }, "removeResourcePolicies": { "id": "compute.instances.removeResourcePolicies", "path": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies", "httpMethod": "POST", "parameters": { "instance": { "description": "The instance name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "InstancesRemoveResourcePoliciesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Removes resource policies from an instance." }, "update": { "id": "compute.instances.update", "path": "projects/{project}/zones/{zone}/instances/{instance}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}", "httpMethod": "PUT", "parameters": { "instance": { "description": "Name of the instance resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "minimalAction": { "description": "Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require.", "location": "query", "type": "string", "enumDescriptions": [ "", "No changes can be made to the instance.", "The instance will not restart.", "The instance will restart." ], "enum": [ "INVALID", "NO_EFFECT", "REFRESH", "RESTART" ] }, "mostDisruptiveAllowedAction": { "description": "Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART.", "location": "query", "type": "string", "enumDescriptions": [ "", "No changes can be made to the instance.", "The instance will not restart.", "The instance will restart." ], "enum": [ "INVALID", "NO_EFFECT", "REFRESH", "RESTART" ] }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "Instance" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties." }, "updateShieldedInstanceConfig": { "id": "compute.instances.updateShieldedInstanceConfig", "path": "projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig", "httpMethod": "PATCH", "parameters": { "instance": { "description": "Name or id of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "ShieldedInstanceConfig" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." }, "updateDisplayDevice": { "id": "compute.instances.updateDisplayDevice", "path": "projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice", "httpMethod": "PATCH", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "DisplayDevice" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." }, "setShieldedInstanceIntegrityPolicy": { "id": "compute.instances.setShieldedInstanceIntegrityPolicy", "path": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy", "httpMethod": "PATCH", "parameters": { "instance": { "description": "Name or id of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "ShieldedInstanceIntegrityPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." }, "setSecurityPolicy": { "id": "compute.instances.setSecurityPolicy", "path": "projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy", "httpMethod": "POST", "parameters": { "instance": { "description": "Name of the Instance resource to which the security policy should be set. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "Name of the zone scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "request": { "$ref": "InstancesSetSecurityPolicyRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the Google Cloud Armor security policy for the specified instance. For more information, see Google Cloud Armor Overview" }, "getShieldedInstanceIdentity": { "id": "compute.instances.getShieldedInstanceIdentity", "path": "projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity", "httpMethod": "GET", "parameters": { "instance": { "description": "Name or id of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance" ], "response": { "$ref": "ShieldedInstanceIdentity" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Returns the Shielded Instance Identity of an instance" }, "bulkInsert": { "id": "compute.instances.bulkInsert", "path": "projects/{project}/zones/{zone}/instances/bulkInsert", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/bulkInsert", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "BulkInsertInstanceResource" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs." }, "getEffectiveFirewalls": { "id": "compute.instances.getEffectiveFirewalls", "path": "projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls", "httpMethod": "GET", "parameters": { "instance": { "description": "Name of the instance scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instance", "networkInterface" ], "response": { "$ref": "InstancesGetEffectiveFirewallsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Returns effective firewalls applied to an interface of the instance." } } }, "regionInstances": { "methods": { "bulkInsert": { "id": "compute.regionInstances.bulkInsert", "path": "projects/{project}/regions/{region}/instances/bulkInsert", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instances/bulkInsert", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "BulkInsertInstanceResource" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates multiple instances in a given region. Count specifies the number of instances to create." } } }, "reservations": { "methods": { "list": { "id": "compute.reservations.list", "path": "projects/{project}/zones/{zone}/reservations", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/reservations", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "ReservationList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "A list of all the reservations that have been configured for the specified project in specified zone." }, "aggregatedList": { "id": "compute.reservations.aggregatedList", "path": "projects/{project}/aggregated/reservations", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/reservations", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "ReservationAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of reservations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.reservations.get", "path": "projects/{project}/zones/{zone}/reservations/{reservation}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "reservation": { "description": "Name of the reservation to retrieve.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Retrieves information about the specified reservation." }, "insert": { "id": "compute.reservations.insert", "path": "projects/{project}/zones/{zone}/reservations", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/reservations", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "Reservation" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a new reservation. For more information, read Reserving zonal resources." }, "delete": { "id": "compute.reservations.delete", "path": "projects/{project}/zones/{zone}/reservations/{reservation}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "reservation": { "description": "Name of the reservation to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "reservation" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified reservation." }, "resize": { "id": "compute.reservations.resize", "path": "projects/{project}/zones/{zone}/reservations/{reservation}/resize", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/resize", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "reservation": { "description": "Name of the reservation to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "reservation" ], "request": { "$ref": "ReservationsResizeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations." }, "update": { "id": "compute.reservations.update", "path": "projects/{project}/zones/{zone}/reservations/{reservation}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "reservation": { "description": "Name of the reservation to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Update_mask indicates fields to be updated as part of this request.", "location": "query", "type": "string", "format": "google-fieldmask" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "reservation" ], "request": { "$ref": "Reservation" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Update share settings of the reservation." }, "getIamPolicy": { "id": "compute.reservations.getIamPolicy", "path": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.reservations.setIamPolicy", "path": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "request": { "$ref": "ZoneSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.reservations.testIamPermissions", "path": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "instanceGroups": { "methods": { "list": { "id": "compute.instanceGroups.list", "path": "projects/{project}/zones/{zone}/instanceGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroups", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone where the instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "InstanceGroupList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead." }, "aggregatedList": { "id": "compute.instanceGroups.aggregatedList", "path": "projects/{project}/aggregated/instanceGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/instanceGroups", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "InstanceGroupAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of instance groups and sorts them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.instanceGroups.get", "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}", "httpMethod": "GET", "parameters": { "instanceGroup": { "description": "The name of the instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone where the instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead." }, "insert": { "id": "compute.instanceGroups.insert", "path": "projects/{project}/zones/{zone}/instanceGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroups", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where you want to create the instance group.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "InstanceGroup" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates an instance group in the specified project using the parameters that are included in the request." }, "delete": { "id": "compute.instanceGroups.delete", "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}", "httpMethod": "DELETE", "parameters": { "instanceGroup": { "description": "The name of the instance group to delete.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroup" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information." }, "addInstances": { "id": "compute.instanceGroups.addInstances", "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroup" ], "request": { "$ref": "InstanceGroupsAddInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network\/subnetwork. Read Adding instances for more information." }, "removeInstances": { "id": "compute.instanceGroups.removeInstances", "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances", "httpMethod": "POST", "parameters": { "instanceGroup": { "description": "The name of the instance group where the specified instances will be removed.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroup" ], "request": { "$ref": "InstanceGroupsRemoveInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted." }, "listInstances": { "id": "compute.instanceGroups.listInstances", "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances", "httpMethod": "POST", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "instanceGroup": { "description": "The name of the instance group from which you want to generate a list of included instances.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone where the instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroup" ], "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" ], "description": "Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use `eq` (equal) or `ne` (not equal) operators." }, "setNamedPorts": { "id": "compute.instanceGroups.setNamedPorts", "path": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroup" ], "request": { "$ref": "InstanceGroupsSetNamedPortsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the named ports for the specified instance group." } } }, "regionInstanceGroups": { "methods": { "list": { "id": "compute.regionInstanceGroups.list", "path": "projects/{project}/regions/{region}/instanceGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroups", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": 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 of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "RegionInstanceGroupList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of instance group resources contained within the specified region." }, "get": { "id": "compute.regionInstanceGroups.get", "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}", "httpMethod": "GET", "parameters": { "instanceGroup": { "description": "Name of the instance group resource to return.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified instance group resource." }, "listInstances": { "id": "compute.regionInstanceGroups.listInstances", "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances", "httpMethod": "POST", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "instanceGroup": { "description": "Name of the regional instance group for which we want to list the instances.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": 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 of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region", "instanceGroup" ], "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" ], "description": "Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported." }, "setNamedPorts": { "id": "compute.regionInstanceGroups.setNamedPorts", "path": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroup" ], "request": { "$ref": "RegionInstanceGroupsSetNamedPortsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the named ports for the specified regional instance group." } } }, "instanceGroupManagers": { "methods": { "list": { "id": "compute.instanceGroupManagers.list", "path": "projects/{project}/zones/{zone}/instanceGroupManagers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "InstanceGroupManagerList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of managed instance groups that are contained within the specified project and zone." }, "aggregatedList": { "id": "compute.instanceGroupManagers.aggregatedList", "path": "projects/{project}/aggregated/instanceGroupManagers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/instanceGroupManagers", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "InstanceGroupManagerAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of managed instance groups and groups them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.instanceGroupManagers.get", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", "httpMethod": "GET", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns all of the details about the specified managed instance group." }, "insert": { "id": "compute.instanceGroupManagers.insert", "path": "projects/{project}/zones/{zone}/instanceGroupManagers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where you want to create the managed instance group.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "InstanceGroupManager" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit." }, "patch": { "id": "compute.instanceGroupManagers.patch", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", "httpMethod": "PATCH", "parameters": { "instanceGroupManager": { "description": "The name of the instance group manager.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where you want to create the managed instance group.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManager" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG." }, "delete": { "id": "compute.instanceGroupManagers.delete", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}", "httpMethod": "DELETE", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information." }, "deleteInstances": { "id": "compute.instanceGroupManagers.deleteInstances", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersDeleteInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request." }, "suspendInstances": { "id": "compute.instanceGroupManagers.suspendInstances", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersSuspendInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request." }, "resumeInstances": { "id": "compute.instanceGroupManagers.resumeInstances", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resumeInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resumeInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersResumeInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request." }, "stopInstances": { "id": "compute.instanceGroupManagers.stopInstances", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersStopInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request." }, "startInstances": { "id": "compute.instanceGroupManagers.startInstances", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersStartInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request." }, "abandonInstances": { "id": "compute.instanceGroupManagers.abandonInstances", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersAbandonInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request." }, "recreateInstances": { "id": "compute.instanceGroupManagers.recreateInstances", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersRecreateInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request." }, "resize": { "id": "compute.instanceGroupManagers.resize", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "size": { "description": "The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.", "location": "query", "required": true, "type": "integer", "format": "int32" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager", "size" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted." }, "setInstanceTemplate": { "id": "compute.instanceGroupManagers.setInstanceTemplate", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersSetInstanceTemplateRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE." }, "setTargetPools": { "id": "compute.instanceGroupManagers.setTargetPools", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersSetTargetPoolsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group." }, "listManagedInstances": { "id": "compute.instanceGroupManagers.listManagedInstances", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances", "httpMethod": "POST", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone where the managed instance group is located.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "response": { "$ref": "InstanceGroupManagersListManagedInstancesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only if the group's `listManagedInstancesResults` field is set to `PAGINATED`." }, "listErrors": { "id": "compute.instanceGroupManagers.listErrors", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "instanceGroupManager": { "description": "The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)\|1-9{0,19}.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "response": { "$ref": "InstanceGroupManagersListErrorsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported." }, "listPerInstanceConfigs": { "id": "compute.instanceGroupManagers.listPerInstanceConfigs", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs", "httpMethod": "POST", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "instanceGroupManager": { "description": "The name of the managed instance group. It should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "response": { "$ref": "InstanceGroupManagersListPerInstanceConfigsResp" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported." }, "updatePerInstanceConfigs": { "id": "compute.instanceGroupManagers.updatePerInstanceConfigs", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersUpdatePerInstanceConfigsReq" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch." }, "patchPerInstanceConfigs": { "id": "compute.instanceGroupManagers.patchPerInstanceConfigs", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersPatchPerInstanceConfigsReq" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch." }, "deletePerInstanceConfigs": { "id": "compute.instanceGroupManagers.deletePerInstanceConfigs", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersDeletePerInstanceConfigsReq" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes selected per-instance configurations for the managed instance group." }, "applyUpdatesToInstances": { "id": "compute.instanceGroupManagers.applyUpdatesToInstances", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located. Should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersApplyUpdatesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and\/or new versions." }, "createInstances": { "id": "compute.instanceGroupManagers.createInstances", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagersCreateInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method." } } }, "instanceGroupManagerResizeRequests": { "methods": { "get": { "id": "compute.instanceGroupManagerResizeRequests.get", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", "httpMethod": "GET", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resizeRequest": { "description": "The name of the resize request. Name 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 scoping this request. Name should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager", "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" ], "description": "Returns all of the details about the specified resize request." }, "insert": { "id": "compute.instanceGroupManagerResizeRequests.insert", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group to which the resize request will be added. Name should conform to RFC1035 or be a resource ID.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located and where the resize request will be created. Name should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManagerResizeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a new resize request that starts provisioning VMs immediately or queues VM creation." }, "list": { "id": "compute.instanceGroupManagerResizeRequests.list", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "instanceGroupManager": { "description": "The name of the managed instance group. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone where the managed instance group is located. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager" ], "response": { "$ref": "InstanceGroupManagerResizeRequestsListResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of resize requests that are contained in the managed instance group." }, "cancel": { "id": "compute.instanceGroupManagerResizeRequests.cancel", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resizeRequest": { "description": "The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager", "resizeRequest" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Cancels the specified resize request and removes it from the queue. Cancelled resize request does no longer wait for the resources to be provisioned. Cancel is only possible for requests that are accepted in the queue." }, "delete": { "id": "compute.instanceGroupManagerResizeRequests.delete", "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", "httpMethod": "DELETE", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resizeRequest": { "description": "The name of the resize request to delete. The name should conform to RFC1035 or be a resource ID.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone where the managed instance group is located. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instanceGroupManager", "resizeRequest" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously." } } }, "regionInstanceGroupManagers": { "methods": { "list": { "id": "compute.regionInstanceGroupManagers.list", "path": "projects/{project}/regions/{region}/instanceGroupManagers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": 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 of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "RegionInstanceGroupManagerList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of managed instance groups that are contained within the specified region." }, "get": { "id": "compute.regionInstanceGroupManagers.get", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", "httpMethod": "GET", "parameters": { "instanceGroupManager": { "description": "Name of the managed instance group to return.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns all of the details about the specified managed instance group." }, "insert": { "id": "compute.regionInstanceGroupManagers.insert", "path": "projects/{project}/regions/{region}/instanceGroupManagers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "InstanceGroupManager" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances." }, "patch": { "id": "compute.regionInstanceGroupManagers.patch", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", "httpMethod": "PATCH", "parameters": { "instanceGroupManager": { "description": "The name of the instance group manager.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "InstanceGroupManager" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG." }, "delete": { "id": "compute.regionInstanceGroupManagers.delete", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}", "httpMethod": "DELETE", "parameters": { "instanceGroupManager": { "description": "Name of the managed instance group to delete.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified managed instance group and all of the instances in that group." }, "deleteInstances": { "id": "compute.regionInstanceGroupManagers.deleteInstances", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "Name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagersDeleteInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request." }, "suspendInstances": { "id": "compute.regionInstanceGroupManagers.suspendInstances", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "Name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagersSuspendInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request." }, "resumeInstances": { "id": "compute.regionInstanceGroupManagers.resumeInstances", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "Name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagersResumeInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request." }, "stopInstances": { "id": "compute.regionInstanceGroupManagers.stopInstances", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagersStopInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request." }, "startInstances": { "id": "compute.regionInstanceGroupManagers.startInstances", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "Name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagersStartInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request." }, "abandonInstances": { "id": "compute.regionInstanceGroupManagers.abandonInstances", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "Name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagersAbandonInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request." }, "recreateInstances": { "id": "compute.regionInstanceGroupManagers.recreateInstances", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "Name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagersRecreateRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request." }, "resize": { "id": "compute.regionInstanceGroupManagers.resize", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "Name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "size": { "description": "Number of instances that should exist in this instance group manager.", "minimum": "0", "location": "query", "required": true, "type": "integer", "format": "int32" } }, "parameterOrder": [ "project", "region", "instanceGroupManager", "size" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted." }, "setInstanceTemplate": { "id": "compute.regionInstanceGroupManagers.setInstanceTemplate", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagersSetTemplateRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected." }, "setTargetPools": { "id": "compute.regionInstanceGroupManagers.setTargetPools", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", "httpMethod": "POST", "parameters": { "instanceGroupManager": { "description": "Name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagersSetTargetPoolsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected." }, "listManagedInstances": { "id": "compute.regionInstanceGroupManagers.listManagedInstances", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances", "httpMethod": "POST", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "instanceGroupManager": { "description": "The name of the managed instance group.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": 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 of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "response": { "$ref": "RegionInstanceGroupManagersListInstancesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only if the group's `listManagedInstancesResults` field is set to `PAGINATED`." }, "listErrors": { "id": "compute.regionInstanceGroupManagers.listErrors", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "instanceGroupManager": { "description": "The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)\|1-9{0,19}.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request. This should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "response": { "$ref": "RegionInstanceGroupManagersListErrorsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported." }, "listPerInstanceConfigs": { "id": "compute.regionInstanceGroupManagers.listPerInstanceConfigs", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs", "httpMethod": "POST", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "instanceGroupManager": { "description": "The name of the managed instance group. It should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": 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 of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "response": { "$ref": "RegionInstanceGroupManagersListInstanceConfigsResp" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported." }, "updatePerInstanceConfigs": { "id": "compute.regionInstanceGroupManagers.updatePerInstanceConfigs", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": 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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagerUpdateInstanceConfigReq" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch." }, "patchPerInstanceConfigs": { "id": "compute.regionInstanceGroupManagers.patchPerInstanceConfigs", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": 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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagerPatchInstanceConfigReq" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch." }, "deletePerInstanceConfigs": { "id": "compute.regionInstanceGroupManagers.deletePerInstanceConfigs", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request, should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagerDeleteInstanceConfigReq" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes selected per-instance configurations for the managed instance group." }, "applyUpdatesToInstances": { "id": "compute.regionInstanceGroupManagers.applyUpdatesToInstances", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request, should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagersApplyUpdatesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Apply updates to selected instances the managed instance group." }, "createInstances": { "id": "compute.regionInstanceGroupManagers.createInstances", "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region where the managed instance group is located. It should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceGroupManager" ], "request": { "$ref": "RegionInstanceGroupManagersCreateInstancesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method." } } }, "autoscalers": { "methods": { "list": { "id": "compute.autoscalers.list", "path": "projects/{project}/zones/{zone}/autoscalers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/autoscalers", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "AutoscalerList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of autoscalers contained within the specified zone." }, "aggregatedList": { "id": "compute.autoscalers.aggregatedList", "path": "projects/{project}/aggregated/autoscalers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/autoscalers", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "AutoscalerAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of autoscalers. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.autoscalers.get", "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}", "httpMethod": "GET", "parameters": { "autoscaler": { "description": "Name of the autoscaler to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the specified autoscaler resource." }, "insert": { "id": "compute.autoscalers.insert", "path": "projects/{project}/zones/{zone}/autoscalers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/autoscalers", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "Autoscaler" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates an autoscaler in the specified project using the data included in the request." }, "update": { "id": "compute.autoscalers.update", "path": "projects/{project}/zones/{zone}/autoscalers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/autoscalers", "httpMethod": "PUT", "parameters": { "autoscaler": { "description": "Name of the autoscaler to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "Autoscaler" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates an autoscaler in the specified project using the data included in the request." }, "patch": { "id": "compute.autoscalers.patch", "path": "projects/{project}/zones/{zone}/autoscalers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/autoscalers", "httpMethod": "PATCH", "parameters": { "autoscaler": { "description": "Name of the autoscaler to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "Autoscaler" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." }, "delete": { "id": "compute.autoscalers.delete", "path": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}", "httpMethod": "DELETE", "parameters": { "autoscaler": { "description": "Name of the autoscaler to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "autoscaler" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified autoscaler." } } }, "regionAutoscalers": { "methods": { "list": { "id": "compute.regionAutoscalers.list", "path": "projects/{project}/regions/{region}/autoscalers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/autoscalers", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "RegionAutoscalerList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of autoscalers contained within the specified region." }, "get": { "id": "compute.regionAutoscalers.get", "path": "projects/{project}/regions/{region}/autoscalers/{autoscaler}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/autoscalers/{autoscaler}", "httpMethod": "GET", "parameters": { "autoscaler": { "description": "Name of the autoscaler to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified autoscaler." }, "insert": { "id": "compute.regionAutoscalers.insert", "path": "projects/{project}/regions/{region}/autoscalers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/autoscalers", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "Autoscaler" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates an autoscaler in the specified project using the data included in the request." }, "update": { "id": "compute.regionAutoscalers.update", "path": "projects/{project}/regions/{region}/autoscalers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/autoscalers", "httpMethod": "PUT", "parameters": { "autoscaler": { "description": "Name of the autoscaler to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "Autoscaler" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates an autoscaler in the specified project using the data included in the request." }, "patch": { "id": "compute.regionAutoscalers.patch", "path": "projects/{project}/regions/{region}/autoscalers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/autoscalers", "httpMethod": "PATCH", "parameters": { "autoscaler": { "description": "Name of the autoscaler to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "Autoscaler" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." }, "delete": { "id": "compute.regionAutoscalers.delete", "path": "projects/{project}/regions/{region}/autoscalers/{autoscaler}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/autoscalers/{autoscaler}", "httpMethod": "DELETE", "parameters": { "autoscaler": { "description": "Name of the autoscaler to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "autoscaler" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified autoscaler." } } }, "backendBuckets": { "methods": { "list": { "id": "compute.backendBuckets.list", "path": "projects/{project}/global/backendBuckets", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendBuckets", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "BackendBucketList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of BackendBucket resources available to the specified project." }, "get": { "id": "compute.backendBuckets.get", "path": "projects/{project}/global/backendBuckets/{backendBucket}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}", "httpMethod": "GET", "parameters": { "backendBucket": { "description": "Name of the BackendBucket resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified BackendBucket resource." }, "insert": { "id": "compute.backendBuckets.insert", "path": "projects/{project}/global/backendBuckets", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendBuckets", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "BackendBucket" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a BackendBucket resource in the specified project using the data included in the request." }, "delete": { "id": "compute.backendBuckets.delete", "path": "projects/{project}/global/backendBuckets/{backendBucket}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}", "httpMethod": "DELETE", "parameters": { "backendBucket": { "description": "Name of the BackendBucket resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "backendBucket" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified BackendBucket resource." }, "update": { "id": "compute.backendBuckets.update", "path": "projects/{project}/global/backendBuckets/{backendBucket}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}", "httpMethod": "PUT", "parameters": { "backendBucket": { "description": "Name of the BackendBucket resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "backendBucket" ], "request": { "$ref": "BackendBucket" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified BackendBucket resource with the data included in the request." }, "patch": { "id": "compute.backendBuckets.patch", "path": "projects/{project}/global/backendBuckets/{backendBucket}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}", "httpMethod": "PATCH", "parameters": { "backendBucket": { "description": "Name of the BackendBucket resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "backendBucket" ], "request": { "$ref": "BackendBucket" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." }, "addSignedUrlKey": { "id": "compute.backendBuckets.addSignedUrlKey", "path": "projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey", "httpMethod": "POST", "parameters": { "backendBucket": { "description": "Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "backendBucket" ], "request": { "$ref": "SignedUrlKey" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Adds a key for validating requests with signed URLs for this backend bucket." }, "deleteSignedUrlKey": { "id": "compute.backendBuckets.deleteSignedUrlKey", "path": "projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey", "httpMethod": "POST", "parameters": { "backendBucket": { "description": "Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "keyName": { "description": "The name of the Signed URL Key to delete.", "location": "query", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "backendBucket", "keyName" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes a key for validating requests with signed URLs for this backend bucket." }, "setEdgeSecurityPolicy": { "id": "compute.backendBuckets.setEdgeSecurityPolicy", "path": "projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy", "httpMethod": "POST", "parameters": { "backendBucket": { "description": "Name of the BackendBucket resource to which the security policy should be set. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "backendBucket" ], "request": { "$ref": "SecurityPolicyReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the edge security policy for the specified backend bucket." }, "getIamPolicy": { "id": "compute.backendBuckets.getIamPolicy", "path": "projects/{project}/global/backendBuckets/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendBuckets/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.backendBuckets.setIamPolicy", "path": "projects/{project}/global/backendBuckets/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendBuckets/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.backendBuckets.testIamPermissions", "path": "projects/{project}/global/backendBuckets/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendBuckets/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "backendServices": { "methods": { "list": { "id": "compute.backendServices.list", "path": "projects/{project}/global/backendServices", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "BackendServiceList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of BackendService resources available to the specified project." }, "aggregatedList": { "id": "compute.backendServices.aggregatedList", "path": "projects/{project}/aggregated/backendServices", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/backendServices", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Name of the project scoping this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "BackendServiceAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of all BackendService resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "listUsable": { "id": "compute.backendServices.listUsable", "path": "projects/{project}/global/backendServices/listUsable", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices/listUsable", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "BackendServiceListUsable" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of all usable backend services in the specified project." }, "get": { "id": "compute.backendServices.get", "path": "projects/{project}/global/backendServices/{backendService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices/{backendService}", "httpMethod": "GET", "parameters": { "backendService": { "description": "Name of the BackendService resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified BackendService resource." }, "insert": { "id": "compute.backendServices.insert", "path": "projects/{project}/global/backendServices", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "BackendService" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview ." }, "delete": { "id": "compute.backendServices.delete", "path": "projects/{project}/global/backendServices/{backendService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices/{backendService}", "httpMethod": "DELETE", "parameters": { "backendService": { "description": "Name of the BackendService resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "backendService" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified BackendService resource." }, "update": { "id": "compute.backendServices.update", "path": "projects/{project}/global/backendServices/{backendService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices/{backendService}", "httpMethod": "PUT", "parameters": { "backendService": { "description": "Name of the BackendService resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "backendService" ], "request": { "$ref": "BackendService" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview." }, "patch": { "id": "compute.backendServices.patch", "path": "projects/{project}/global/backendServices/{backendService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices/{backendService}", "httpMethod": "PATCH", "parameters": { "backendService": { "description": "Name of the BackendService resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "backendService" ], "request": { "$ref": "BackendService" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." }, "addSignedUrlKey": { "id": "compute.backendServices.addSignedUrlKey", "path": "projects/{project}/global/backendServices/{backendService}/addSignedUrlKey", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices/{backendService}/addSignedUrlKey", "httpMethod": "POST", "parameters": { "backendService": { "description": "Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "backendService" ], "request": { "$ref": "SignedUrlKey" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Adds a key for validating requests with signed URLs for this backend service." }, "deleteSignedUrlKey": { "id": "compute.backendServices.deleteSignedUrlKey", "path": "projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey", "httpMethod": "POST", "parameters": { "backendService": { "description": "Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "keyName": { "description": "The name of the Signed URL Key to delete.", "location": "query", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "backendService", "keyName" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes a key for validating requests with signed URLs for this backend service." }, "setSecurityPolicy": { "id": "compute.backendServices.setSecurityPolicy", "path": "projects/{project}/global/backendServices/{backendService}/setSecurityPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices/{backendService}/setSecurityPolicy", "httpMethod": "POST", "parameters": { "backendService": { "description": "Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "backendService" ], "request": { "$ref": "SecurityPolicyReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview" }, "setEdgeSecurityPolicy": { "id": "compute.backendServices.setEdgeSecurityPolicy", "path": "projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy", "httpMethod": "POST", "parameters": { "backendService": { "description": "Name of the BackendService resource to which the edge security policy should be set. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "backendService" ], "request": { "$ref": "SecurityPolicyReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the edge security policy for the specified backend service." }, "getHealth": { "id": "compute.backendServices.getHealth", "path": "projects/{project}/global/backendServices/{backendService}/getHealth", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices/{backendService}/getHealth", "httpMethod": "POST", "parameters": { "backendService": { "description": "Name of the BackendService resource to which the queried instance belongs.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "backendService" ], "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" ], "description": "Gets the most recent health check results for this BackendService. Example request body: { \"group\": \"\/zones\/us-east1-b\/instanceGroups\/lb-backend-example\" }" }, "getIamPolicy": { "id": "compute.backendServices.getIamPolicy", "path": "projects/{project}/global/backendServices/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.backendServices.setIamPolicy", "path": "projects/{project}/global/backendServices/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.backendServices.testIamPermissions", "path": "projects/{project}/global/backendServices/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/backendServices/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "regionBackendServices": { "methods": { "list": { "id": "compute.regionBackendServices.list", "path": "projects/{project}/regions/{region}/backendServices", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/backendServices", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "BackendServiceList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of regional BackendService resources available to the specified project in the given region." }, "listUsable": { "id": "compute.regionBackendServices.listUsable", "path": "projects/{project}/regions/{region}/backendServices/listUsable", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/backendServices/listUsable", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request. It 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 of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "BackendServiceListUsable" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of all usable backend services in the specified project in the given region." }, "get": { "id": "compute.regionBackendServices.get", "path": "projects/{project}/regions/{region}/backendServices/{backendService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}", "httpMethod": "GET", "parameters": { "backendService": { "description": "Name of the BackendService resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified regional BackendService resource." }, "insert": { "id": "compute.regionBackendServices.insert", "path": "projects/{project}/regions/{region}/backendServices", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/backendServices", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "BackendService" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview." }, "delete": { "id": "compute.regionBackendServices.delete", "path": "projects/{project}/regions/{region}/backendServices/{backendService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}", "httpMethod": "DELETE", "parameters": { "backendService": { "description": "Name of the BackendService resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "backendService" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified regional BackendService resource." }, "update": { "id": "compute.regionBackendServices.update", "path": "projects/{project}/regions/{region}/backendServices/{backendService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}", "httpMethod": "PUT", "parameters": { "backendService": { "description": "Name of the BackendService resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "backendService" ], "request": { "$ref": "BackendService" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview ." }, "patch": { "id": "compute.regionBackendServices.patch", "path": "projects/{project}/regions/{region}/backendServices/{backendService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}", "httpMethod": "PATCH", "parameters": { "backendService": { "description": "Name of the BackendService resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "backendService" ], "request": { "$ref": "BackendService" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules." }, "setSecurityPolicy": { "id": "compute.regionBackendServices.setSecurityPolicy", "path": "projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy", "httpMethod": "POST", "parameters": { "backendService": { "description": "Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "backendService" ], "request": { "$ref": "SecurityPolicyReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview" }, "getHealth": { "id": "compute.regionBackendServices.getHealth", "path": "projects/{project}/regions/{region}/backendServices/{backendService}/getHealth", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}/getHealth", "httpMethod": "POST", "parameters": { "backendService": { "description": "Name of the BackendService resource for which to get health.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "backendService" ], "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" ], "description": "Gets the most recent health check results for this regional BackendService." }, "getIamPolicy": { "id": "compute.regionBackendServices.getIamPolicy", "path": "projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.regionBackendServices.setIamPolicy", "path": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.regionBackendServices.testIamPermissions", "path": "projects/{project}/regions/{region}/backendServices/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/backendServices/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "regionCommitments": { "methods": { "list": { "id": "compute.regionCommitments.list", "path": "projects/{project}/regions/{region}/commitments", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/commitments", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "CommitmentList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of commitments contained within the specified region." }, "aggregatedList": { "id": "compute.regionCommitments.aggregatedList", "path": "projects/{project}/aggregated/commitments", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/commitments", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "CommitmentAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of commitments by region. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.regionCommitments.get", "path": "projects/{project}/regions/{region}/commitments/{commitment}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}", "httpMethod": "GET", "parameters": { "commitment": { "description": "Name of the commitment to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified commitment resource." }, "insert": { "id": "compute.regionCommitments.insert", "path": "projects/{project}/regions/{region}/commitments", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/commitments", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "Commitment" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a commitment in the specified project using the data included in the request." }, "update": { "id": "compute.regionCommitments.update", "path": "projects/{project}/regions/{region}/commitments/{commitment}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/commitments/{commitment}", "httpMethod": "PATCH", "parameters": { "commitment": { "description": "Name of the commitment that you want to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "updateMask": { "description": "update_mask indicates fields to be updated as part of this request.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "project", "region", "commitment" ], "request": { "$ref": "Commitment" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be updated: auto_renew and plan." } } }, "diskTypes": { "methods": { "list": { "id": "compute.diskTypes.list", "path": "projects/{project}/zones/{zone}/diskTypes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/diskTypes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "DiskTypeList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of disk types available to the specified project." }, "aggregatedList": { "id": "compute.diskTypes.aggregatedList", "path": "projects/{project}/aggregated/diskTypes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/diskTypes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "DiskTypeAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of disk types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.diskTypes.get", "path": "projects/{project}/zones/{zone}/diskTypes/{diskType}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/diskTypes/{diskType}", "httpMethod": "GET", "parameters": { "diskType": { "description": "Name of the disk type to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the specified disk type." } } }, "regionDiskTypes": { "methods": { "list": { "id": "compute.regionDiskTypes.list", "path": "projects/{project}/regions/{region}/diskTypes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/diskTypes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "RegionDiskTypeList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of regional disk types available to the specified project." }, "get": { "id": "compute.regionDiskTypes.get", "path": "projects/{project}/regions/{region}/diskTypes/{diskType}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/diskTypes/{diskType}", "httpMethod": "GET", "parameters": { "diskType": { "description": "Name of the disk type to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified regional disk type." } } }, "interconnectAttachments": { "methods": { "list": { "id": "compute.interconnectAttachments.list", "path": "projects/{project}/regions/{region}/interconnectAttachments", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/interconnectAttachments", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "InterconnectAttachmentList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of interconnect attachments contained within the specified region." }, "aggregatedList": { "id": "compute.interconnectAttachments.aggregatedList", "path": "projects/{project}/aggregated/interconnectAttachments", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/interconnectAttachments", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "InterconnectAttachmentAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of interconnect attachments. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.interconnectAttachments.get", "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", "httpMethod": "GET", "parameters": { "interconnectAttachment": { "description": "Name of the interconnect attachment to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified interconnect attachment." }, "insert": { "id": "compute.interconnectAttachments.insert", "path": "projects/{project}/regions/{region}/interconnectAttachments", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/interconnectAttachments", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { "description": "If true, the request will not be committed.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "InterconnectAttachment" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates an InterconnectAttachment in the specified project using the data included in the request." }, "patch": { "id": "compute.interconnectAttachments.patch", "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", "httpMethod": "PATCH", "parameters": { "interconnectAttachment": { "description": "Name of the interconnect attachment to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "interconnectAttachment" ], "request": { "$ref": "InterconnectAttachment" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." }, "delete": { "id": "compute.interconnectAttachments.delete", "path": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}", "httpMethod": "DELETE", "parameters": { "interconnectAttachment": { "description": "Name of the interconnect attachment to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "interconnectAttachment" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified interconnect attachment." }, "setLabels": { "id": "compute.interconnectAttachments.setLabels", "path": "projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation." } } }, "interconnects": { "methods": { "insert": { "id": "compute.interconnects.insert", "path": "projects/{project}/global/interconnects", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/interconnects", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "Interconnect" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates an Interconnect in the specified project using the data included in the request." }, "list": { "id": "compute.interconnects.list", "path": "projects/{project}/global/interconnects", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/interconnects", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "InterconnectList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of Interconnects available to the specified project." }, "getDiagnostics": { "id": "compute.interconnects.getDiagnostics", "path": "projects/{project}/global/interconnects/{interconnect}/getDiagnostics", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/interconnects/{interconnect}/getDiagnostics", "httpMethod": "GET", "parameters": { "interconnect": { "description": "Name of the interconnect resource to query.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "interconnect" ], "response": { "$ref": "InterconnectsGetDiagnosticsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Returns the interconnectDiagnostics for the specified Interconnect. In the event of a global outage, do not use this API to make decisions about where to redirect your network traffic. Unlike a VLAN attachment, which is regional, a Cloud Interconnect connection is a global resource. A global outage can prevent this API from functioning properly." }, "getMacsecConfig": { "id": "compute.interconnects.getMacsecConfig", "path": "projects/{project}/global/interconnects/{interconnect}/getMacsecConfig", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/interconnects/{interconnect}/getMacsecConfig", "httpMethod": "GET", "parameters": { "interconnect": { "description": "Name of the interconnect resource to query.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "interconnect" ], "response": { "$ref": "InterconnectsGetMacsecConfigResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Returns the interconnectMacsecConfig for the specified Interconnect." }, "get": { "id": "compute.interconnects.get", "path": "projects/{project}/global/interconnects/{interconnect}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/interconnects/{interconnect}", "httpMethod": "GET", "parameters": { "interconnect": { "description": "Name of the interconnect to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified Interconnect. Get a list of available Interconnects by making a list() request." }, "delete": { "id": "compute.interconnects.delete", "path": "projects/{project}/global/interconnects/{interconnect}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/interconnects/{interconnect}", "httpMethod": "DELETE", "parameters": { "interconnect": { "description": "Name of the interconnect to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "interconnect" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified Interconnect." }, "patch": { "id": "compute.interconnects.patch", "path": "projects/{project}/global/interconnects/{interconnect}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/interconnects/{interconnect}", "httpMethod": "PATCH", "parameters": { "interconnect": { "description": "Name of the interconnect to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "interconnect" ], "request": { "$ref": "Interconnect" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." }, "setLabels": { "id": "compute.interconnects.setLabels", "path": "projects/{project}/global/interconnects/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/interconnects/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation." } } }, "externalVpnGateways": { "methods": { "insert": { "id": "compute.externalVpnGateways.insert", "path": "projects/{project}/global/externalVpnGateways", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/externalVpnGateways", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "ExternalVpnGateway" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a ExternalVpnGateway in the specified project using the data included in the request." }, "list": { "id": "compute.externalVpnGateways.list", "path": "projects/{project}/global/externalVpnGateways", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/externalVpnGateways", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "ExternalVpnGatewayList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of ExternalVpnGateway available to the specified project." }, "get": { "id": "compute.externalVpnGateways.get", "path": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}", "httpMethod": "GET", "parameters": { "externalVpnGateway": { "description": "Name of the externalVpnGateway to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request." }, "delete": { "id": "compute.externalVpnGateways.delete", "path": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}", "httpMethod": "DELETE", "parameters": { "externalVpnGateway": { "description": "Name of the externalVpnGateways to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "externalVpnGateway" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified externalVpnGateway." }, "testIamPermissions": { "id": "compute.externalVpnGateways.testIamPermissions", "path": "projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." }, "setLabels": { "id": "compute.externalVpnGateways.setLabels", "path": "projects/{project}/global/externalVpnGateways/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/externalVpnGateways/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation." } } }, "globalForwardingRules": { "methods": { "list": { "id": "compute.globalForwardingRules.list", "path": "projects/{project}/global/forwardingRules", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/forwardingRules", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "ForwardingRuleList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of GlobalForwardingRule resources available to the specified project." }, "get": { "id": "compute.globalForwardingRules.get", "path": "projects/{project}/global/forwardingRules/{forwardingRule}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}", "httpMethod": "GET", "parameters": { "forwardingRule": { "description": "Name of the ForwardingRule resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request." }, "insert": { "id": "compute.globalForwardingRules.insert", "path": "projects/{project}/global/forwardingRules", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/forwardingRules", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "ForwardingRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a GlobalForwardingRule resource in the specified project using the data included in the request." }, "delete": { "id": "compute.globalForwardingRules.delete", "path": "projects/{project}/global/forwardingRules/{forwardingRule}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}", "httpMethod": "DELETE", "parameters": { "forwardingRule": { "description": "Name of the ForwardingRule resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "forwardingRule" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified GlobalForwardingRule resource." }, "setTarget": { "id": "compute.globalForwardingRules.setTarget", "path": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget", "httpMethod": "POST", "parameters": { "forwardingRule": { "description": "Name of the ForwardingRule resource in which target is to be set.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "forwardingRule" ], "request": { "$ref": "TargetReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target." }, "patch": { "id": "compute.globalForwardingRules.patch", "path": "projects/{project}/global/forwardingRules/{forwardingRule}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}", "httpMethod": "PATCH", "parameters": { "forwardingRule": { "description": "Name of the ForwardingRule resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "forwardingRule" ], "request": { "$ref": "ForwardingRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field." }, "setLabels": { "id": "compute.globalForwardingRules.setLabels", "path": "projects/{project}/global/forwardingRules/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/forwardingRules/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation." } } }, "forwardingRules": { "methods": { "list": { "id": "compute.forwardingRules.list", "path": "projects/{project}/regions/{region}/forwardingRules", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/forwardingRules", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "ForwardingRuleList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of ForwardingRule resources available to the specified project and region." }, "aggregatedList": { "id": "compute.forwardingRules.aggregatedList", "path": "projects/{project}/aggregated/forwardingRules", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/forwardingRules", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "ForwardingRuleAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of forwarding rules. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.forwardingRules.get", "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", "httpMethod": "GET", "parameters": { "forwardingRule": { "description": "Name of the ForwardingRule resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified ForwardingRule resource." }, "insert": { "id": "compute.forwardingRules.insert", "path": "projects/{project}/regions/{region}/forwardingRules", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/forwardingRules", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "ForwardingRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request." }, "delete": { "id": "compute.forwardingRules.delete", "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", "httpMethod": "DELETE", "parameters": { "forwardingRule": { "description": "Name of the ForwardingRule resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "forwardingRule" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified ForwardingRule resource." }, "setTarget": { "id": "compute.forwardingRules.setTarget", "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget", "httpMethod": "POST", "parameters": { "forwardingRule": { "description": "Name of the ForwardingRule resource in which target is to be set.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "forwardingRule" ], "request": { "$ref": "TargetReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes target URL for forwarding rule. The new target should be of the same type as the old target." }, "patch": { "id": "compute.forwardingRules.patch", "path": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", "httpMethod": "PATCH", "parameters": { "forwardingRule": { "description": "Name of the ForwardingRule resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "forwardingRule" ], "request": { "$ref": "ForwardingRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field." }, "setLabels": { "id": "compute.forwardingRules.setLabels", "path": "projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation." } } }, "regionHealthCheckServices": { "methods": { "list": { "id": "compute.regionHealthCheckServices.list", "path": "projects/{project}/regions/{region}/healthCheckServices", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/healthCheckServices", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "HealthCheckServicesList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all the HealthCheckService resources that have been configured for the specified project in the given region." }, "get": { "id": "compute.regionHealthCheckServices.get", "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "httpMethod": "GET", "parameters": { "healthCheckService": { "description": "Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified regional HealthCheckService resource." }, "insert": { "id": "compute.regionHealthCheckServices.insert", "path": "projects/{project}/regions/{region}/healthCheckServices", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/healthCheckServices", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "HealthCheckService" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a regional HealthCheckService resource in the specified project and region using the data included in the request." }, "delete": { "id": "compute.regionHealthCheckServices.delete", "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "httpMethod": "DELETE", "parameters": { "healthCheckService": { "description": "Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "healthCheckService" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified regional HealthCheckService." }, "patch": { "id": "compute.regionHealthCheckServices.patch", "path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "httpMethod": "PATCH", "parameters": { "healthCheckService": { "description": "Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "healthCheckService" ], "request": { "$ref": "HealthCheckService" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." } } }, "healthChecks": { "methods": { "list": { "id": "compute.healthChecks.list", "path": "projects/{project}/global/healthChecks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/healthChecks", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "HealthCheckList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of HealthCheck resources available to the specified project." }, "aggregatedList": { "id": "compute.healthChecks.aggregatedList", "path": "projects/{project}/aggregated/healthChecks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/healthChecks", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Name of the project scoping this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "HealthChecksAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.healthChecks.get", "path": "projects/{project}/global/healthChecks/{healthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", "httpMethod": "GET", "parameters": { "healthCheck": { "description": "Name of the HealthCheck resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified HealthCheck resource." }, "insert": { "id": "compute.healthChecks.insert", "path": "projects/{project}/global/healthChecks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/healthChecks", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "HealthCheck" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a HealthCheck resource in the specified project using the data included in the request." }, "delete": { "id": "compute.healthChecks.delete", "path": "projects/{project}/global/healthChecks/{healthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", "httpMethod": "DELETE", "parameters": { "healthCheck": { "description": "Name of the HealthCheck resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "healthCheck" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified HealthCheck resource." }, "update": { "id": "compute.healthChecks.update", "path": "projects/{project}/global/healthChecks/{healthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", "httpMethod": "PUT", "parameters": { "healthCheck": { "description": "Name of the HealthCheck resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "healthCheck" ], "request": { "$ref": "HealthCheck" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates a HealthCheck resource in the specified project using the data included in the request." }, "patch": { "id": "compute.healthChecks.patch", "path": "projects/{project}/global/healthChecks/{healthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", "httpMethod": "PATCH", "parameters": { "healthCheck": { "description": "Name of the HealthCheck resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "healthCheck" ], "request": { "$ref": "HealthCheck" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." } } }, "regionHealthChecks": { "methods": { "list": { "id": "compute.regionHealthChecks.list", "path": "projects/{project}/regions/{region}/healthChecks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/healthChecks", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "HealthCheckList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of HealthCheck resources available to the specified project." }, "get": { "id": "compute.regionHealthChecks.get", "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", "httpMethod": "GET", "parameters": { "healthCheck": { "description": "Name of the HealthCheck resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified HealthCheck resource." }, "insert": { "id": "compute.regionHealthChecks.insert", "path": "projects/{project}/regions/{region}/healthChecks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/healthChecks", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "HealthCheck" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a HealthCheck resource in the specified project using the data included in the request." }, "delete": { "id": "compute.regionHealthChecks.delete", "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", "httpMethod": "DELETE", "parameters": { "healthCheck": { "description": "Name of the HealthCheck resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "healthCheck" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified HealthCheck resource." }, "update": { "id": "compute.regionHealthChecks.update", "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", "httpMethod": "PUT", "parameters": { "healthCheck": { "description": "Name of the HealthCheck resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "healthCheck" ], "request": { "$ref": "HealthCheck" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates a HealthCheck resource in the specified project using the data included in the request." }, "patch": { "id": "compute.regionHealthChecks.patch", "path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", "httpMethod": "PATCH", "parameters": { "healthCheck": { "description": "Name of the HealthCheck resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "healthCheck" ], "request": { "$ref": "HealthCheck" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." } } }, "httpHealthChecks": { "methods": { "list": { "id": "compute.httpHealthChecks.list", "path": "projects/{project}/global/httpHealthChecks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/httpHealthChecks", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "HttpHealthCheckList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of HttpHealthCheck resources available to the specified project." }, "get": { "id": "compute.httpHealthChecks.get", "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "httpMethod": "GET", "parameters": { "httpHealthCheck": { "description": "Name of the HttpHealthCheck resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified HttpHealthCheck resource." }, "insert": { "id": "compute.httpHealthChecks.insert", "path": "projects/{project}/global/httpHealthChecks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/httpHealthChecks", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "HttpHealthCheck" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a HttpHealthCheck resource in the specified project using the data included in the request." }, "delete": { "id": "compute.httpHealthChecks.delete", "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "httpMethod": "DELETE", "parameters": { "httpHealthCheck": { "description": "Name of the HttpHealthCheck resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "httpHealthCheck" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified HttpHealthCheck resource." }, "update": { "id": "compute.httpHealthChecks.update", "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "httpMethod": "PUT", "parameters": { "httpHealthCheck": { "description": "Name of the HttpHealthCheck resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "httpHealthCheck" ], "request": { "$ref": "HttpHealthCheck" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request." }, "patch": { "id": "compute.httpHealthChecks.patch", "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "httpMethod": "PATCH", "parameters": { "httpHealthCheck": { "description": "Name of the HttpHealthCheck resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "httpHealthCheck" ], "request": { "$ref": "HttpHealthCheck" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." } } }, "httpsHealthChecks": { "methods": { "list": { "id": "compute.httpsHealthChecks.list", "path": "projects/{project}/global/httpsHealthChecks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/httpsHealthChecks", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "HttpsHealthCheckList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of HttpsHealthCheck resources available to the specified project." }, "get": { "id": "compute.httpsHealthChecks.get", "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", "httpMethod": "GET", "parameters": { "httpsHealthCheck": { "description": "Name of the HttpsHealthCheck resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified HttpsHealthCheck resource." }, "insert": { "id": "compute.httpsHealthChecks.insert", "path": "projects/{project}/global/httpsHealthChecks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/httpsHealthChecks", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "HttpsHealthCheck" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a HttpsHealthCheck resource in the specified project using the data included in the request." }, "delete": { "id": "compute.httpsHealthChecks.delete", "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", "httpMethod": "DELETE", "parameters": { "httpsHealthCheck": { "description": "Name of the HttpsHealthCheck resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "httpsHealthCheck" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified HttpsHealthCheck resource." }, "update": { "id": "compute.httpsHealthChecks.update", "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", "httpMethod": "PUT", "parameters": { "httpsHealthCheck": { "description": "Name of the HttpsHealthCheck resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "httpsHealthCheck" ], "request": { "$ref": "HttpsHealthCheck" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request." }, "patch": { "id": "compute.httpsHealthChecks.patch", "path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}", "httpMethod": "PATCH", "parameters": { "httpsHealthCheck": { "description": "Name of the HttpsHealthCheck resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "httpsHealthCheck" ], "request": { "$ref": "HttpsHealthCheck" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." } } }, "instanceTemplates": { "methods": { "list": { "id": "compute.instanceTemplates.list", "path": "projects/{project}/global/instanceTemplates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/instanceTemplates", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "InstanceTemplateList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of instance templates that are contained within the specified project." }, "get": { "id": "compute.instanceTemplates.get", "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/instanceTemplates/{instanceTemplate}", "httpMethod": "GET", "parameters": { "instanceTemplate": { "description": "The name of the instance template.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified instance template." }, "insert": { "id": "compute.instanceTemplates.insert", "path": "projects/{project}/global/instanceTemplates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/instanceTemplates", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "InstanceTemplate" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template." }, "delete": { "id": "compute.instanceTemplates.delete", "path": "projects/{project}/global/instanceTemplates/{instanceTemplate}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/instanceTemplates/{instanceTemplate}", "httpMethod": "DELETE", "parameters": { "instanceTemplate": { "description": "The name of the instance template to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "instanceTemplate" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group." }, "aggregatedList": { "id": "compute.instanceTemplates.aggregatedList", "path": "projects/{project}/aggregated/instanceTemplates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/instanceTemplates", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Name of the project scoping this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "InstanceTemplateAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "getIamPolicy": { "id": "compute.instanceTemplates.getIamPolicy", "path": "projects/{project}/global/instanceTemplates/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/instanceTemplates/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.instanceTemplates.setIamPolicy", "path": "projects/{project}/global/instanceTemplates/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/instanceTemplates/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.instanceTemplates.testIamPermissions", "path": "projects/{project}/global/instanceTemplates/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/instanceTemplates/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "regionInstanceTemplates": { "methods": { "list": { "id": "compute.regionInstanceTemplates.list", "path": "projects/{project}/regions/{region}/instanceTemplates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceTemplates", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the regions for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "InstanceTemplateList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of instance templates that are contained within the specified project and region." }, "get": { "id": "compute.regionInstanceTemplates.get", "path": "projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}", "httpMethod": "GET", "parameters": { "instanceTemplate": { "description": "The name of the instance template.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified instance template." }, "insert": { "id": "compute.regionInstanceTemplates.insert", "path": "projects/{project}/regions/{region}/instanceTemplates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceTemplates", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "InstanceTemplate" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates an instance template in the specified project and region using the global instance template whose URL is included in the request." }, "delete": { "id": "compute.regionInstanceTemplates.delete", "path": "projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}", "httpMethod": "DELETE", "parameters": { "instanceTemplate": { "description": "The name of the instance template to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instanceTemplate" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone." } } }, "instanceSettings": { "methods": { "get": { "id": "compute.instanceSettings.get", "path": "projects/{project}/zones/{zone}/instanceSettings", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceSettings", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "InstanceSettings" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Get Instance settings." }, "patch": { "id": "compute.instanceSettings.patch", "path": "projects/{project}/zones/{zone}/instanceSettings", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instanceSettings", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "updateMask": { "description": "update_mask indicates fields to be updated as part of this request.", "location": "query", "type": "string", "format": "google-fieldmask" }, "zone": { "description": "The zone scoping this request. It should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "InstanceSettings" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patch Instance settings" } } }, "instantSnapshots": { "methods": { "list": { "id": "compute.instantSnapshots.list", "path": "projects/{project}/zones/{zone}/instantSnapshots", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instantSnapshots", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "InstantSnapshotList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of InstantSnapshot resources contained within the specified zone." }, "get": { "id": "compute.instantSnapshots.get", "path": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", "httpMethod": "GET", "parameters": { "instantSnapshot": { "description": "Name of the InstantSnapshot resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the specified InstantSnapshot resource in the specified zone." }, "insert": { "id": "compute.instantSnapshots.insert", "path": "projects/{project}/zones/{zone}/instantSnapshots", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instantSnapshots", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "Name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "InstantSnapshot" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates an instant snapshot in the specified zone." }, "setLabels": { "id": "compute.instantSnapshots.setLabels", "path": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "request": { "$ref": "ZoneSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation." }, "delete": { "id": "compute.instantSnapshots.delete", "path": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", "httpMethod": "DELETE", "parameters": { "instantSnapshot": { "description": "Name of the InstantSnapshot resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "instantSnapshot" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots." }, "getIamPolicy": { "id": "compute.instantSnapshots.getIamPolicy", "path": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.instantSnapshots.setIamPolicy", "path": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "request": { "$ref": "ZoneSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.instantSnapshots.testIamPermissions", "path": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." }, "aggregatedList": { "id": "compute.instantSnapshots.aggregatedList", "path": "projects/{project}/aggregated/instantSnapshots", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/instantSnapshots", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "InstantSnapshotAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." } } }, "regionInstantSnapshots": { "methods": { "list": { "id": "compute.regionInstantSnapshots.list", "path": "projects/{project}/regions/{region}/instantSnapshots", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instantSnapshots", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "InstantSnapshotList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of InstantSnapshot resources contained within the specified region." }, "get": { "id": "compute.regionInstantSnapshots.get", "path": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}", "httpMethod": "GET", "parameters": { "instantSnapshot": { "description": "Name of the InstantSnapshot resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified InstantSnapshot resource in the specified region." }, "insert": { "id": "compute.regionInstantSnapshots.insert", "path": "projects/{project}/regions/{region}/instantSnapshots", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instantSnapshots", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "InstantSnapshot" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates an instant snapshot in the specified region." }, "setLabels": { "id": "compute.regionInstantSnapshots.setLabels", "path": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on a instantSnapshot in the given region. To learn more about labels, read the Labeling Resources documentation." }, "delete": { "id": "compute.regionInstantSnapshots.delete", "path": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}", "httpMethod": "DELETE", "parameters": { "instantSnapshot": { "description": "Name of the InstantSnapshot resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "instantSnapshot" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots." }, "getIamPolicy": { "id": "compute.regionInstantSnapshots.getIamPolicy", "path": "projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.regionInstantSnapshots.setIamPolicy", "path": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.regionInstantSnapshots.testIamPermissions", "path": "projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "interconnectLocations": { "methods": { "list": { "id": "compute.interconnectLocations.list", "path": "projects/{project}/global/interconnectLocations", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/interconnectLocations", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "InterconnectLocationList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of interconnect locations available to the specified project." }, "get": { "id": "compute.interconnectLocations.get", "path": "projects/{project}/global/interconnectLocations/{interconnectLocation}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/interconnectLocations/{interconnectLocation}", "httpMethod": "GET", "parameters": { "interconnectLocation": { "description": "Name of the interconnect location to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request." } } }, "interconnectRemoteLocations": { "methods": { "list": { "id": "compute.interconnectRemoteLocations.list", "path": "projects/{project}/global/interconnectRemoteLocations", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/interconnectRemoteLocations", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "InterconnectRemoteLocationList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of interconnect remote locations available to the specified project." }, "get": { "id": "compute.interconnectRemoteLocations.get", "path": "projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}", "httpMethod": "GET", "parameters": { "interconnectRemoteLocation": { "description": "Name of the interconnect remote location to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making a list() request." } } }, "licenseCodes": { "methods": { "get": { "id": "compute.licenseCodes.get", "path": "projects/{project}/global/licenseCodes/{licenseCode}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/licenseCodes/{licenseCode}", "httpMethod": "GET", "parameters": { "licenseCode": { "description": "Number corresponding to the License code resource to return.", "pattern": "[0-9]{0,61}?", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. " }, "testIamPermissions": { "id": "compute.licenseCodes.testIamPermissions", "path": "projects/{project}/global/licenseCodes/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/licenseCodes/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource. Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. " } } }, "licenses": { "methods": { "get": { "id": "compute.licenses.get", "path": "projects/{project}/global/licenses/{license}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/licenses/{license}", "httpMethod": "GET", "parameters": { "license": { "description": "Name of the License resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified License resource. Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. " }, "list": { "id": "compute.licenses.list", "path": "projects/{project}/global/licenses", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/licenses", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "LicensesListResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. " }, "delete": { "id": "compute.licenses.delete", "path": "projects/{project}/global/licenses/{license}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/licenses/{license}", "httpMethod": "DELETE", "parameters": { "license": { "description": "Name of the license resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "license" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified license. Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. " }, "insert": { "id": "compute.licenses.insert", "path": "projects/{project}/global/licenses", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/licenses", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "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" ], "description": "Create a License resource in the specified project. Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. " }, "getIamPolicy": { "id": "compute.licenses.getIamPolicy", "path": "projects/{project}/global/licenses/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/licenses/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists. Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. " }, "setIamPolicy": { "id": "compute.licenses.setIamPolicy", "path": "projects/{project}/global/licenses/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/licenses/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. " }, "testIamPermissions": { "id": "compute.licenses.testIamPermissions", "path": "projects/{project}/global/licenses/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/licenses/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource. Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. " } } }, "machineImages": { "methods": { "list": { "id": "compute.machineImages.list", "path": "projects/{project}/global/machineImages", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/machineImages", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "MachineImageList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of machine images that are contained within the specified project." }, "get": { "id": "compute.machineImages.get", "path": "projects/{project}/global/machineImages/{machineImage}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/machineImages/{machineImage}", "httpMethod": "GET", "parameters": { "machineImage": { "description": "The name of the machine image.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified machine image." }, "insert": { "id": "compute.machineImages.insert", "path": "projects/{project}/global/machineImages", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/machineImages", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "sourceInstance": { "description": "Required. Source instance that is used to create the machine image from.", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "MachineImage" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance." }, "delete": { "id": "compute.machineImages.delete", "path": "projects/{project}/global/machineImages/{machineImage}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/machineImages/{machineImage}", "httpMethod": "DELETE", "parameters": { "machineImage": { "description": "The name of the machine image to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "machineImage" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone." }, "getIamPolicy": { "id": "compute.machineImages.getIamPolicy", "path": "projects/{project}/global/machineImages/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/machineImages/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.machineImages.setIamPolicy", "path": "projects/{project}/global/machineImages/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/machineImages/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "request": { "$ref": "GlobalSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.machineImages.testIamPermissions", "path": "projects/{project}/global/machineImages/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/machineImages/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "machineTypes": { "methods": { "list": { "id": "compute.machineTypes.list", "path": "projects/{project}/zones/{zone}/machineTypes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/machineTypes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "MachineTypeList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of machine types available to the specified project." }, "aggregatedList": { "id": "compute.machineTypes.aggregatedList", "path": "projects/{project}/aggregated/machineTypes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/machineTypes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "MachineTypeAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.machineTypes.get", "path": "projects/{project}/zones/{zone}/machineTypes/{machineType}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/machineTypes/{machineType}", "httpMethod": "GET", "parameters": { "machineType": { "description": "Name of the machine type to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the specified machine type." } } }, "networkAttachments": { "methods": { "aggregatedList": { "id": "compute.networkAttachments.aggregatedList", "path": "projects/{project}/aggregated/networkAttachments", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/networkAttachments", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "NetworkAttachmentAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "list": { "id": "compute.networkAttachments.list", "path": "projects/{project}/regions/{region}/networkAttachments", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkAttachments", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region of this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "NetworkAttachmentList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists the NetworkAttachments for a project in the given scope." }, "get": { "id": "compute.networkAttachments.get", "path": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}", "httpMethod": "GET", "parameters": { "networkAttachment": { "description": "Name of the NetworkAttachment resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region of this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified NetworkAttachment resource in the given scope." }, "insert": { "id": "compute.networkAttachments.insert", "path": "projects/{project}/regions/{region}/networkAttachments", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkAttachments", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region of this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "NetworkAttachment" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request." }, "delete": { "id": "compute.networkAttachments.delete", "path": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}", "httpMethod": "DELETE", "parameters": { "networkAttachment": { "description": "Name of the NetworkAttachment resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region of this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "networkAttachment" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified NetworkAttachment in the given scope" }, "patch": { "id": "compute.networkAttachments.patch", "path": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}", "httpMethod": "PATCH", "parameters": { "networkAttachment": { "description": "Name of the NetworkAttachment resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "networkAttachment" ], "request": { "$ref": "NetworkAttachment" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified NetworkAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules." }, "getIamPolicy": { "id": "compute.networkAttachments.getIamPolicy", "path": "projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.networkAttachments.setIamPolicy", "path": "projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.networkAttachments.testIamPermissions", "path": "projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "networkEdgeSecurityServices": { "methods": { "get": { "id": "compute.networkEdgeSecurityServices.get", "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", "httpMethod": "GET", "parameters": { "networkEdgeSecurityService": { "description": "Name of the network edge security service to get.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Gets a specified NetworkEdgeSecurityService." }, "insert": { "id": "compute.networkEdgeSecurityServices.insert", "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { "description": "If true, the request will not be committed.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "NetworkEdgeSecurityService" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a new service in the specified project using the data included in the request." }, "delete": { "id": "compute.networkEdgeSecurityServices.delete", "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", "httpMethod": "DELETE", "parameters": { "networkEdgeSecurityService": { "description": "Name of the network edge security service to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "networkEdgeSecurityService" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified service." }, "patch": { "id": "compute.networkEdgeSecurityServices.patch", "path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}", "httpMethod": "PATCH", "parameters": { "networkEdgeSecurityService": { "description": "Name of the network edge security service to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "updateMask": { "description": "Indicates fields to be updated as part of this request.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "project", "region", "networkEdgeSecurityService" ], "request": { "$ref": "NetworkEdgeSecurityService" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified policy with the data included in the request." }, "aggregatedList": { "id": "compute.networkEdgeSecurityServices.aggregatedList", "path": "projects/{project}/aggregated/networkEdgeSecurityServices", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/networkEdgeSecurityServices", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Name of the project scoping this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "NetworkEdgeSecurityServiceAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." } } }, "networkEndpointGroups": { "methods": { "list": { "id": "compute.networkEndpointGroups.list", "path": "projects/{project}/zones/{zone}/networkEndpointGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "NetworkEndpointGroupList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of network endpoint groups that are located in the specified project and zone." }, "aggregatedList": { "id": "compute.networkEndpointGroups.aggregatedList", "path": "projects/{project}/aggregated/networkEndpointGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/networkEndpointGroups", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "NetworkEndpointGroupAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of network endpoint groups and sorts them by zone. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.networkEndpointGroups.get", "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}", "httpMethod": "GET", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the specified network endpoint group." }, "insert": { "id": "compute.networkEndpointGroups.insert", "path": "projects/{project}/zones/{zone}/networkEndpointGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "NetworkEndpointGroup" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a network endpoint group in the specified project using the parameters that are included in the request." }, "delete": { "id": "compute.networkEndpointGroups.delete", "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}", "httpMethod": "DELETE", "parameters": { "networkEndpointGroup": { "description": "The name of the network endpoint group to delete. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "networkEndpointGroup" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it." }, "attachNetworkEndpoints": { "id": "compute.networkEndpointGroups.attachNetworkEndpoints", "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", "httpMethod": "POST", "parameters": { "networkEndpointGroup": { "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "networkEndpointGroup" ], "request": { "$ref": "NetworkEndpointGroupsAttachEndpointsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Attach a list of network endpoints to the specified network endpoint group." }, "detachNetworkEndpoints": { "id": "compute.networkEndpointGroups.detachNetworkEndpoints", "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", "httpMethod": "POST", "parameters": { "networkEndpointGroup": { "description": "The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "networkEndpointGroup" ], "request": { "$ref": "NetworkEndpointGroupsDetachEndpointsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Detach a list of network endpoints from the specified network endpoint group." }, "listNetworkEndpoints": { "id": "compute.networkEndpointGroups.listNetworkEndpoints", "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", "httpMethod": "POST", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "networkEndpointGroup": { "description": "The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "networkEndpointGroup" ], "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" ], "description": "Lists the network endpoints in the specified network endpoint group." }, "testIamPermissions": { "id": "compute.networkEndpointGroups.testIamPermissions", "path": "projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "globalNetworkEndpointGroups": { "methods": { "list": { "id": "compute.globalNetworkEndpointGroups.list", "path": "projects/{project}/global/networkEndpointGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networkEndpointGroups", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "NetworkEndpointGroupList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of network endpoint groups that are located in the specified project." }, "get": { "id": "compute.globalNetworkEndpointGroups.get", "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", "httpMethod": "GET", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified network endpoint group." }, "insert": { "id": "compute.globalNetworkEndpointGroups.insert", "path": "projects/{project}/global/networkEndpointGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networkEndpointGroups", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "NetworkEndpointGroup" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a network endpoint group in the specified project using the parameters that are included in the request." }, "delete": { "id": "compute.globalNetworkEndpointGroups.delete", "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}", "httpMethod": "DELETE", "parameters": { "networkEndpointGroup": { "description": "The name of the network endpoint group to delete. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "networkEndpointGroup" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it." }, "attachNetworkEndpoints": { "id": "compute.globalNetworkEndpointGroups.attachNetworkEndpoints", "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", "httpMethod": "POST", "parameters": { "networkEndpointGroup": { "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "networkEndpointGroup" ], "request": { "$ref": "GlobalNetworkEndpointGroupsAttachEndpointsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Attach a network endpoint to the specified network endpoint group." }, "detachNetworkEndpoints": { "id": "compute.globalNetworkEndpointGroups.detachNetworkEndpoints", "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", "httpMethod": "POST", "parameters": { "networkEndpointGroup": { "description": "The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "networkEndpointGroup" ], "request": { "$ref": "GlobalNetworkEndpointGroupsDetachEndpointsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Detach the network endpoint from the specified network endpoint group." }, "listNetworkEndpoints": { "id": "compute.globalNetworkEndpointGroups.listNetworkEndpoints", "path": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", "httpMethod": "POST", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "networkEndpointGroup": { "description": "The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "networkEndpointGroup" ], "response": { "$ref": "NetworkEndpointGroupsListNetworkEndpoints" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists the network endpoints in the specified network endpoint group." } } }, "regionNetworkEndpointGroups": { "methods": { "list": { "id": "compute.regionNetworkEndpointGroups.list", "path": "projects/{project}/regions/{region}/networkEndpointGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region where 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 of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "NetworkEndpointGroupList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of regional network endpoint groups available to the specified project in the given region." }, "get": { "id": "compute.regionNetworkEndpointGroups.get", "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", "httpMethod": "GET", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified network endpoint group." }, "insert": { "id": "compute.regionNetworkEndpointGroups.insert", "path": "projects/{project}/regions/{region}/networkEndpointGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region where you want to create the network endpoint group. 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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "NetworkEndpointGroup" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a network endpoint group in the specified project using the parameters that are included in the request." }, "delete": { "id": "compute.regionNetworkEndpointGroups.delete", "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", "httpMethod": "DELETE", "parameters": { "networkEndpointGroup": { "description": "The name of the network endpoint group to delete. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region where the 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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "networkEndpointGroup" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service." }, "attachNetworkEndpoints": { "id": "compute.regionNetworkEndpointGroups.attachNetworkEndpoints", "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", "httpMethod": "POST", "parameters": { "networkEndpointGroup": { "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region where you want to create the network endpoint group. 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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "networkEndpointGroup" ], "request": { "$ref": "RegionNetworkEndpointGroupsAttachEndpointsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Attach a list of network endpoints to the specified network endpoint group." }, "detachNetworkEndpoints": { "id": "compute.regionNetworkEndpointGroups.detachNetworkEndpoints", "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", "httpMethod": "POST", "parameters": { "networkEndpointGroup": { "description": "The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region where the 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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "networkEndpointGroup" ], "request": { "$ref": "RegionNetworkEndpointGroupsDetachEndpointsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Detach the network endpoint from the specified network endpoint group." }, "listNetworkEndpoints": { "id": "compute.regionNetworkEndpointGroups.listNetworkEndpoints", "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", "httpMethod": "POST", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "networkEndpointGroup": { "description": "The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.", "location": "path", "required": true, "type": "string" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region where 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 of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region", "networkEndpointGroup" ], "response": { "$ref": "NetworkEndpointGroupsListNetworkEndpoints" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists the network endpoints in the specified network endpoint group." } } }, "networks": { "methods": { "list": { "id": "compute.networks.list", "path": "projects/{project}/global/networks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networks", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "NetworkList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of networks available to the specified project." }, "get": { "id": "compute.networks.get", "path": "projects/{project}/global/networks/{network}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networks/{network}", "httpMethod": "GET", "parameters": { "network": { "description": "Name of the network to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified network." }, "insert": { "id": "compute.networks.insert", "path": "projects/{project}/global/networks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networks", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "Network" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a network in the specified project using the data included in the request." }, "delete": { "id": "compute.networks.delete", "path": "projects/{project}/global/networks/{network}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networks/{network}", "httpMethod": "DELETE", "parameters": { "network": { "description": "Name of the network to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "network" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified network." }, "patch": { "id": "compute.networks.patch", "path": "projects/{project}/global/networks/{network}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networks/{network}", "httpMethod": "PATCH", "parameters": { "network": { "description": "Name of the network to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "network" ], "request": { "$ref": "Network" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified network with the data included in the request. Only routingConfig can be modified." }, "updatePeering": { "id": "compute.networks.updatePeering", "path": "projects/{project}/global/networks/{network}/updatePeering", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networks/{network}/updatePeering", "httpMethod": "PATCH", "parameters": { "network": { "description": "Name of the network resource which the updated peering is belonging to.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "network" ], "request": { "$ref": "NetworksUpdatePeeringRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified network peering with the data included in the request. You can only modify the NetworkPeering.export_custom_routes field and the NetworkPeering.import_custom_routes field." }, "addPeering": { "id": "compute.networks.addPeering", "path": "projects/{project}/global/networks/{network}/addPeering", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networks/{network}/addPeering", "httpMethod": "POST", "parameters": { "network": { "description": "Name of the network resource to add peering to.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "network" ], "request": { "$ref": "NetworksAddPeeringRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Adds a peering to the specified network." }, "removePeering": { "id": "compute.networks.removePeering", "path": "projects/{project}/global/networks/{network}/removePeering", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networks/{network}/removePeering", "httpMethod": "POST", "parameters": { "network": { "description": "Name of the network resource to remove peering from.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "network" ], "request": { "$ref": "NetworksRemovePeeringRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Removes a peering from the specified network." }, "switchToCustomMode": { "id": "compute.networks.switchToCustomMode", "path": "projects/{project}/global/networks/{network}/switchToCustomMode", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networks/{network}/switchToCustomMode", "httpMethod": "POST", "parameters": { "network": { "description": "Name of the network to be updated.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "network" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Switches the network mode from auto subnet mode to custom subnet mode." }, "getEffectiveFirewalls": { "id": "compute.networks.getEffectiveFirewalls", "path": "projects/{project}/global/networks/{network}/getEffectiveFirewalls", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networks/{network}/getEffectiveFirewalls", "httpMethod": "GET", "parameters": { "network": { "description": "Name of the network for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "network" ], "response": { "$ref": "NetworksGetEffectiveFirewallsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Returns the effective firewalls on a given network." }, "listPeeringRoutes": { "id": "compute.networks.listPeeringRoutes", "path": "projects/{project}/global/networks/{network}/listPeeringRoutes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/networks/{network}/listPeeringRoutes", "httpMethod": "GET", "parameters": { "direction": { "description": "The direction of the exchanged routes.", "location": "query", "type": "string", "enumDescriptions": [ "For routes exported from peer network.", "For routes exported from local network." ], "enum": [ "INCOMING", "OUTGOING" ] }, "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "network": { "description": "Name of the network for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "peeringName": { "description": "The response will show routes exchanged over the given peering connection.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "network" ], "response": { "$ref": "ExchangedPeeringRoutesList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists the peering routes exchanged over peering connection." } } }, "nodeGroups": { "methods": { "list": { "id": "compute.nodeGroups.list", "path": "projects/{project}/zones/{zone}/nodeGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "NodeGroupList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group." }, "aggregatedList": { "id": "compute.nodeGroups.aggregatedList", "path": "projects/{project}/aggregated/nodeGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/nodeGroups", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "NodeGroupAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.nodeGroups.get", "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", "httpMethod": "GET", "parameters": { "nodeGroup": { "description": "Name of the node group to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the \"nodes\" field should not be used. Use nodeGroups.listNodes instead." }, "insert": { "id": "compute.nodeGroups.insert", "path": "projects/{project}/zones/{zone}/nodeGroups", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups", "httpMethod": "POST", "parameters": { "initialNodeCount": { "description": "Initial count of nodes in the node group.", "location": "query", "required": true, "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "initialNodeCount" ], "request": { "$ref": "NodeGroup" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a NodeGroup resource in the specified project using the data included in the request." }, "delete": { "id": "compute.nodeGroups.delete", "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", "httpMethod": "DELETE", "parameters": { "nodeGroup": { "description": "Name of the NodeGroup resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "nodeGroup" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified NodeGroup resource." }, "addNodes": { "id": "compute.nodeGroups.addNodes", "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes", "httpMethod": "POST", "parameters": { "nodeGroup": { "description": "Name of the NodeGroup resource.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "nodeGroup" ], "request": { "$ref": "NodeGroupsAddNodesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Adds specified number of nodes to the node group." }, "deleteNodes": { "id": "compute.nodeGroups.deleteNodes", "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes", "httpMethod": "POST", "parameters": { "nodeGroup": { "description": "Name of the NodeGroup resource whose nodes will be deleted.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "nodeGroup" ], "request": { "$ref": "NodeGroupsDeleteNodesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes specified nodes from the node group." }, "listNodes": { "id": "compute.nodeGroups.listNodes", "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes", "httpMethod": "POST", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "nodeGroup": { "description": "Name of the NodeGroup resource whose nodes you want to list.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "nodeGroup" ], "response": { "$ref": "NodeGroupsListNodes" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists nodes in the node group." }, "setNodeTemplate": { "id": "compute.nodeGroups.setNodeTemplate", "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate", "httpMethod": "POST", "parameters": { "nodeGroup": { "description": "Name of the NodeGroup resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "nodeGroup" ], "request": { "$ref": "NodeGroupsSetNodeTemplateRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the node template of the node group." }, "patch": { "id": "compute.nodeGroups.patch", "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}", "httpMethod": "PATCH", "parameters": { "nodeGroup": { "description": "Name of the NodeGroup resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "nodeGroup" ], "request": { "$ref": "NodeGroup" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified node group." }, "simulateMaintenanceEvent": { "id": "compute.nodeGroups.simulateMaintenanceEvent", "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent", "httpMethod": "POST", "parameters": { "nodeGroup": { "description": "Name of the NodeGroup resource whose nodes will go under maintenance simulation.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "nodeGroup" ], "request": { "$ref": "NodeGroupsSimulateMaintenanceEventRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Simulates maintenance event on specified nodes from the node group." }, "performMaintenance": { "id": "compute.nodeGroups.performMaintenance", "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance", "httpMethod": "POST", "parameters": { "nodeGroup": { "description": "Name of the node group scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "nodeGroup" ], "request": { "$ref": "NodeGroupsPerformMaintenanceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Perform maintenance on a subset of nodes in the node group." }, "getIamPolicy": { "id": "compute.nodeGroups.getIamPolicy", "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.nodeGroups.setIamPolicy", "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "request": { "$ref": "ZoneSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.nodeGroups.testIamPermissions", "path": "projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "nodeTemplates": { "methods": { "list": { "id": "compute.nodeTemplates.list", "path": "projects/{project}/regions/{region}/nodeTemplates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/nodeTemplates", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "NodeTemplateList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of node templates available to the specified project." }, "aggregatedList": { "id": "compute.nodeTemplates.aggregatedList", "path": "projects/{project}/aggregated/nodeTemplates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/nodeTemplates", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "NodeTemplateAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of node templates. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.nodeTemplates.get", "path": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}", "httpMethod": "GET", "parameters": { "nodeTemplate": { "description": "Name of the node template to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified node template." }, "insert": { "id": "compute.nodeTemplates.insert", "path": "projects/{project}/regions/{region}/nodeTemplates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/nodeTemplates", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "NodeTemplate" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a NodeTemplate resource in the specified project using the data included in the request." }, "delete": { "id": "compute.nodeTemplates.delete", "path": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}", "httpMethod": "DELETE", "parameters": { "nodeTemplate": { "description": "Name of the NodeTemplate resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "nodeTemplate" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified NodeTemplate resource." }, "getIamPolicy": { "id": "compute.nodeTemplates.getIamPolicy", "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.nodeTemplates.setIamPolicy", "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.nodeTemplates.testIamPermissions", "path": "projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "nodeTypes": { "methods": { "list": { "id": "compute.nodeTypes.list", "path": "projects/{project}/zones/{zone}/nodeTypes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeTypes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "NodeTypeList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of node types available to the specified project." }, "aggregatedList": { "id": "compute.nodeTypes.aggregatedList", "path": "projects/{project}/aggregated/nodeTypes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/nodeTypes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "NodeTypeAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.nodeTypes.get", "path": "projects/{project}/zones/{zone}/nodeTypes/{nodeType}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/nodeTypes/{nodeType}", "httpMethod": "GET", "parameters": { "nodeType": { "description": "Name of the node type to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the specified node type." } } }, "regionNotificationEndpoints": { "methods": { "list": { "id": "compute.regionNotificationEndpoints.list", "path": "projects/{project}/regions/{region}/notificationEndpoints", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "NotificationEndpointList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists the NotificationEndpoints for a project in the given region." }, "get": { "id": "compute.regionNotificationEndpoints.get", "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", "httpMethod": "GET", "parameters": { "notificationEndpoint": { "description": "Name of the NotificationEndpoint resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified NotificationEndpoint resource in the given region." }, "insert": { "id": "compute.regionNotificationEndpoints.insert", "path": "projects/{project}/regions/{region}/notificationEndpoints", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/notificationEndpoints", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "NotificationEndpoint" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request." }, "delete": { "id": "compute.regionNotificationEndpoints.delete", "path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}", "httpMethod": "DELETE", "parameters": { "notificationEndpoint": { "description": "Name of the NotificationEndpoint resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "notificationEndpoint" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified NotificationEndpoint in the given region" } } }, "packetMirrorings": { "methods": { "get": { "id": "compute.packetMirrorings.get", "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", "httpMethod": "GET", "parameters": { "packetMirroring": { "description": "Name of the PacketMirroring resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified PacketMirroring resource." }, "insert": { "id": "compute.packetMirrorings.insert", "path": "projects/{project}/regions/{region}/packetMirrorings", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/packetMirrorings", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "PacketMirroring" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a PacketMirroring resource in the specified project and region using the data included in the request." }, "patch": { "id": "compute.packetMirrorings.patch", "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", "httpMethod": "PATCH", "parameters": { "packetMirroring": { "description": "Name of the PacketMirroring resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "packetMirroring" ], "request": { "$ref": "PacketMirroring" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules." }, "delete": { "id": "compute.packetMirrorings.delete", "path": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}", "httpMethod": "DELETE", "parameters": { "packetMirroring": { "description": "Name of the PacketMirroring resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "packetMirroring" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified PacketMirroring resource." }, "list": { "id": "compute.packetMirrorings.list", "path": "projects/{project}/regions/{region}/packetMirrorings", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/packetMirrorings", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "PacketMirroringList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of PacketMirroring resources available to the specified project and region." }, "aggregatedList": { "id": "compute.packetMirrorings.aggregatedList", "path": "projects/{project}/aggregated/packetMirrorings", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/packetMirrorings", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "PacketMirroringAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of packetMirrorings. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "testIamPermissions": { "id": "compute.packetMirrorings.testIamPermissions", "path": "projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "projects": { "methods": { "get": { "id": "compute.projects.get", "path": "projects/{project}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "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" ], "description": "Returns the specified Project resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request." }, "setCommonInstanceMetadata": { "id": "compute.projects.setCommonInstanceMetadata", "path": "projects/{project}/setCommonInstanceMetadata", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/setCommonInstanceMetadata", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "Metadata" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets metadata common to all instances within the specified project using the data included in the request." }, "setUsageExportBucket": { "id": "compute.projects.setUsageExportBucket", "path": "projects/{project}/setUsageExportBucket", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/setUsageExportBucket", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "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" ], "description": "Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled." }, "moveInstance": { "id": "compute.projects.moveInstance", "path": "projects/{project}/moveInstance", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/moveInstance", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "InstanceMoveRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "deprecated": true, "description": "Moves an instance and its attached persistent disks from one zone to another. Note: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](\/compute\/docs\/troubleshooting\/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](\/compute\/docs\/instances\/moving-instance-across-zones) instead." }, "moveDisk": { "id": "compute.projects.moveDisk", "path": "projects/{project}/moveDisk", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/moveDisk", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "DiskMoveRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Moves a persistent disk from one zone to another." }, "listXpnHosts": { "id": "compute.projects.listXpnHosts", "path": "projects/{project}/listXpnHosts", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/listXpnHosts", "httpMethod": "POST", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "request": { "$ref": "ProjectsListXpnHostsRequest" }, "response": { "$ref": "XpnHostList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Lists all shared VPC host projects visible to the user in an organization." }, "enableXpnHost": { "id": "compute.projects.enableXpnHost", "path": "projects/{project}/enableXpnHost", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/enableXpnHost", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Enable this project as a shared VPC host project." }, "disableXpnHost": { "id": "compute.projects.disableXpnHost", "path": "projects/{project}/disableXpnHost", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/disableXpnHost", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Disable this project as a shared VPC host project." }, "enableXpnResource": { "id": "compute.projects.enableXpnResource", "path": "projects/{project}/enableXpnResource", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/enableXpnResource", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "ProjectsEnableXpnResourceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project." }, "disableXpnResource": { "id": "compute.projects.disableXpnResource", "path": "projects/{project}/disableXpnResource", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/disableXpnResource", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "ProjectsDisableXpnResourceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Disable a service resource (also known as service project) associated with this host project." }, "getXpnHost": { "id": "compute.projects.getXpnHost", "path": "projects/{project}/getXpnHost", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/getXpnHost", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project" ], "response": { "$ref": "Project" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Gets the shared VPC host project that this project links to. May be empty if no link exists." }, "getXpnResources": { "id": "compute.projects.getXpnResources", "path": "projects/{project}/getXpnResources", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/getXpnResources", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "ProjectsGetXpnResources" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Gets service resources (a.k.a service project) associated with this host project." }, "setDefaultNetworkTier": { "id": "compute.projects.setDefaultNetworkTier", "path": "projects/{project}/setDefaultNetworkTier", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/setDefaultNetworkTier", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "ProjectsSetDefaultNetworkTierRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the default network tier of the project. The default network tier is used when an address\/forwardingRule\/instance is created without specifying the network tier field." }, "setCloudArmorTier": { "id": "compute.projects.setCloudArmorTier", "path": "projects/{project}/setCloudArmorTier", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/setCloudArmorTier", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "ProjectsSetCloudArmorTierRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the billing account of the project must be subscribed to Cloud Armor Enterprise. See Subscribing to Cloud Armor Enterprise for more information." } } }, "publicAdvertisedPrefixes": { "methods": { "list": { "id": "compute.publicAdvertisedPrefixes.list", "path": "projects/{project}/global/publicAdvertisedPrefixes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/publicAdvertisedPrefixes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "PublicAdvertisedPrefixList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists the PublicAdvertisedPrefixes for a project." }, "get": { "id": "compute.publicAdvertisedPrefixes.get", "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "publicAdvertisedPrefix": { "description": "Name of the PublicAdvertisedPrefix resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified PublicAdvertisedPrefix resource." }, "insert": { "id": "compute.publicAdvertisedPrefixes.insert", "path": "projects/{project}/global/publicAdvertisedPrefixes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/publicAdvertisedPrefixes", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "PublicAdvertisedPrefix" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request." }, "delete": { "id": "compute.publicAdvertisedPrefixes.delete", "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "publicAdvertisedPrefix": { "description": "Name of the PublicAdvertisedPrefix resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "publicAdvertisedPrefix" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified PublicAdvertisedPrefix" }, "patch": { "id": "compute.publicAdvertisedPrefixes.patch", "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "publicAdvertisedPrefix": { "description": "Name of the PublicAdvertisedPrefix resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "publicAdvertisedPrefix" ], "request": { "$ref": "PublicAdvertisedPrefix" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules." }, "announce": { "id": "compute.publicAdvertisedPrefixes.announce", "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/announce", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/announce", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": 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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "publicAdvertisedPrefix" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Announces the specified PublicAdvertisedPrefix" }, "withdraw": { "id": "compute.publicAdvertisedPrefixes.withdraw", "path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/withdraw", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/withdraw", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": 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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "publicAdvertisedPrefix" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Withdraws the specified PublicAdvertisedPrefix" } } }, "globalPublicDelegatedPrefixes": { "methods": { "list": { "id": "compute.globalPublicDelegatedPrefixes.list", "path": "projects/{project}/global/publicDelegatedPrefixes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/publicDelegatedPrefixes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "PublicDelegatedPrefixList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists the global PublicDelegatedPrefixes for a project." }, "get": { "id": "compute.globalPublicDelegatedPrefixes.get", "path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "publicDelegatedPrefix": { "description": "Name of the PublicDelegatedPrefix resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified global PublicDelegatedPrefix resource." }, "insert": { "id": "compute.globalPublicDelegatedPrefixes.insert", "path": "projects/{project}/global/publicDelegatedPrefixes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/publicDelegatedPrefixes", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "PublicDelegatedPrefix" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request." }, "delete": { "id": "compute.globalPublicDelegatedPrefixes.delete", "path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "publicDelegatedPrefix": { "description": "Name of the PublicDelegatedPrefix resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "publicDelegatedPrefix" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified global PublicDelegatedPrefix." }, "patch": { "id": "compute.globalPublicDelegatedPrefixes.patch", "path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "publicDelegatedPrefix": { "description": "Name of the PublicDelegatedPrefix resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "publicDelegatedPrefix" ], "request": { "$ref": "PublicDelegatedPrefix" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules." } } }, "publicDelegatedPrefixes": { "methods": { "list": { "id": "compute.publicDelegatedPrefixes.list", "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region of this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "PublicDelegatedPrefixList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists the PublicDelegatedPrefixes for a project in the given region." }, "get": { "id": "compute.publicDelegatedPrefixes.get", "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "publicDelegatedPrefix": { "description": "Name of the PublicDelegatedPrefix resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region of this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified PublicDelegatedPrefix resource in the given region." }, "insert": { "id": "compute.publicDelegatedPrefixes.insert", "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region of this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "PublicDelegatedPrefix" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request." }, "delete": { "id": "compute.publicDelegatedPrefixes.delete", "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "publicDelegatedPrefix": { "description": "Name of the PublicDelegatedPrefix resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region of this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "publicDelegatedPrefix" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified PublicDelegatedPrefix in the given region." }, "patch": { "id": "compute.publicDelegatedPrefixes.patch", "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "publicDelegatedPrefix": { "description": "Name of the PublicDelegatedPrefix resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "publicDelegatedPrefix" ], "request": { "$ref": "PublicDelegatedPrefix" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules." }, "announce": { "id": "compute.publicDelegatedPrefixes.announce", "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/announce", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/announce", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": 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 the region where the 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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "publicDelegatedPrefix" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Announces the specified PublicDelegatedPrefix in the given region." }, "withdraw": { "id": "compute.publicDelegatedPrefixes.withdraw", "path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/withdraw", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/withdraw", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": 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 the region where the 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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region", "publicDelegatedPrefix" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Withdraws the specified PublicDelegatedPrefix in the given region." }, "aggregatedList": { "id": "compute.publicDelegatedPrefixes.aggregatedList", "path": "projects/{project}/aggregated/publicDelegatedPrefixes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/publicDelegatedPrefixes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Name of the project scoping this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "PublicDelegatedPrefixAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." } } }, "regions": { "methods": { "list": { "id": "compute.regions.list", "path": "projects/{project}/regions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "RegionList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method." }, "get": { "id": "compute.regions.get", "path": "projects/{project}/regions/{region}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method." } } }, "subnetworks": { "methods": { "list": { "id": "compute.subnetworks.list", "path": "projects/{project}/regions/{region}/subnetworks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/subnetworks", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "SubnetworkList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of subnetworks available to the specified project." }, "aggregatedList": { "id": "compute.subnetworks.aggregatedList", "path": "projects/{project}/aggregated/subnetworks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/subnetworks", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "SubnetworkAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of subnetworks. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "listUsable": { "id": "compute.subnetworks.listUsable", "path": "projects/{project}/aggregated/subnetworks/listUsable", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/subnetworks/listUsable", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "UsableSubnetworksAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of all usable subnetworks in the project." }, "get": { "id": "compute.subnetworks.get", "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "subnetwork": { "description": "Name of the Subnetwork resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified subnetwork." }, "insert": { "id": "compute.subnetworks.insert", "path": "projects/{project}/regions/{region}/subnetworks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/subnetworks", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "Subnetwork" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a subnetwork in the specified project using the data included in the request." }, "delete": { "id": "compute.subnetworks.delete", "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "subnetwork": { "description": "Name of the Subnetwork resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "subnetwork" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified subnetwork." }, "expandIpCidrRange": { "id": "compute.subnetworks.expandIpCidrRange", "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "subnetwork": { "description": "Name of the Subnetwork resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "subnetwork" ], "request": { "$ref": "SubnetworksExpandIpCidrRangeRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Expands the IP CIDR range of the subnetwork to a specified value." }, "patch": { "id": "compute.subnetworks.patch", "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}", "httpMethod": "PATCH", "parameters": { "drainTimeoutSeconds": { "description": "The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "subnetwork": { "description": "Name of the Subnetwork resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "subnetwork" ], "request": { "$ref": "Subnetwork" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched." }, "getIamPolicy": { "id": "compute.subnetworks.getIamPolicy", "path": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.subnetworks.setIamPolicy", "path": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.subnetworks.testIamPermissions", "path": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." }, "setPrivateIpGoogleAccess": { "id": "compute.subnetworks.setPrivateIpGoogleAccess", "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "subnetwork": { "description": "Name of the Subnetwork resource.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "subnetwork" ], "request": { "$ref": "SubnetworksSetPrivateIpGoogleAccessRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access." } } }, "resourcePolicies": { "methods": { "list": { "id": "compute.resourcePolicies.list", "path": "projects/{project}/regions/{region}/resourcePolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/resourcePolicies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "ResourcePolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "A list all the resource policies that have been configured for the specified project in specified region." }, "aggregatedList": { "id": "compute.resourcePolicies.aggregatedList", "path": "projects/{project}/aggregated/resourcePolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/resourcePolicies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "ResourcePolicyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of resource policies. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.resourcePolicies.get", "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resourcePolicy": { "description": "Name of the resource policy to retrieve.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Retrieves all information of the specified resource policy." }, "insert": { "id": "compute.resourcePolicies.insert", "path": "projects/{project}/regions/{region}/resourcePolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/resourcePolicies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "ResourcePolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a new resource policy." }, "delete": { "id": "compute.resourcePolicies.delete", "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resourcePolicy": { "description": "Name of the resource policy to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resourcePolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified resource policy." }, "patch": { "id": "compute.resourcePolicies.patch", "path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resourcePolicy": { "description": "Id of the resource policy to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "update_mask indicates fields to be updated as part of this request.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "project", "region", "resourcePolicy" ], "request": { "$ref": "ResourcePolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Modify the specified resource policy." }, "getIamPolicy": { "id": "compute.resourcePolicies.getIamPolicy", "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.resourcePolicies.setIamPolicy", "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.resourcePolicies.testIamPermissions", "path": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "routes": { "methods": { "list": { "id": "compute.routes.list", "path": "projects/{project}/global/routes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/routes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "RouteList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of Route resources available to the specified project." }, "get": { "id": "compute.routes.get", "path": "projects/{project}/global/routes/{route}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/routes/{route}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "route": { "description": "Name of the Route resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified Route resource." }, "insert": { "id": "compute.routes.insert", "path": "projects/{project}/global/routes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/routes", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "Route" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a Route resource in the specified project using the data included in the request." }, "delete": { "id": "compute.routes.delete", "path": "projects/{project}/global/routes/{route}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/routes/{route}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "route": { "description": "Name of the Route resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "route" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified Route resource." } } }, "routers": { "methods": { "get": { "id": "compute.routers.get", "path": "projects/{project}/regions/{region}/routers/{router}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "router": { "description": "Name of the Router resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified Router resource." }, "insert": { "id": "compute.routers.insert", "path": "projects/{project}/regions/{region}/routers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "Router" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a Router resource in the specified project and region using the data included in the request." }, "update": { "id": "compute.routers.update", "path": "projects/{project}/regions/{region}/routers/{router}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}", "httpMethod": "PUT", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "router": { "description": "Name of the Router resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "router" ], "request": { "$ref": "Router" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload." }, "patch": { "id": "compute.routers.patch", "path": "projects/{project}/regions/{region}/routers/{router}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "router": { "description": "Name of the Router resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "router" ], "request": { "$ref": "Router" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules." }, "delete": { "id": "compute.routers.delete", "path": "projects/{project}/regions/{region}/routers/{router}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "router": { "description": "Name of the Router resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "router" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified Router resource." }, "list": { "id": "compute.routers.list", "path": "projects/{project}/regions/{region}/routers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "RouterList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of Router resources available to the specified project." }, "aggregatedList": { "id": "compute.routers.aggregatedList", "path": "projects/{project}/aggregated/routers", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/routers", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "RouterAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "getRouterStatus": { "id": "compute.routers.getRouterStatus", "path": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "router": { "description": "Name of the Router resource to query.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "router" ], "response": { "$ref": "RouterStatusResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves runtime information of the specified router." }, "getNatMappingInfo": { "id": "compute.routers.getNatMappingInfo", "path": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "natName": { "description": "Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.", "location": "query", "type": "string" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "router": { "description": "Name of the Router resource to query for Nat Mapping information of VM endpoints.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "router" ], "response": { "$ref": "VmEndpointNatMappingsList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves runtime Nat mapping information of VM endpoints." }, "getNatIpInfo": { "id": "compute.routers.getNatIpInfo", "path": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo", "httpMethod": "GET", "parameters": { "natName": { "description": "Name of the nat service to filter the NAT IP information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "router": { "description": "Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "router" ], "response": { "$ref": "NatIpInfoResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves runtime NAT IP information." }, "preview": { "id": "compute.routers.preview", "path": "projects/{project}/regions/{region}/routers/{router}/preview", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}/preview", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "router": { "description": "Name of the Router resource to query.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "router" ], "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" ], "description": "Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router." }, "updateRoutePolicy": { "id": "compute.routers.updateRoutePolicy", "path": "projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "router": { "description": "Name of the Router resource where Route Policy is defined.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "router" ], "request": { "$ref": "RoutePolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates or creates new Route Policy" }, "patchRoutePolicy": { "id": "compute.routers.patchRoutePolicy", "path": "projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "router": { "description": "Name of the Router resource where Route Policy is defined.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "router" ], "request": { "$ref": "RoutePolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches Route Policy" }, "deleteRoutePolicy": { "id": "compute.routers.deleteRoutePolicy", "path": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", "httpMethod": "POST", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "router": { "description": "Name of the Router resource where Route Policy is defined.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "router" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes Route Policy" }, "getRoutePolicy": { "id": "compute.routers.getRoutePolicy", "path": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy", "httpMethod": "GET", "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.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "router": { "description": "Name of the Router resource to query for the route policy. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "router" ], "response": { "$ref": "RoutersGetRoutePolicyResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Returns specified Route Policy" }, "listRoutePolicies": { "id": "compute.routers.listRoutePolicies", "path": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "router": { "description": "Name or id of the resource for this request. Name should conform to RFC1035.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "router" ], "response": { "$ref": "RoutersListRoutePolicies" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of router route policy subresources available to the specified project." }, "listBgpRoutes": { "id": "compute.routers.listBgpRoutes", "path": "projects/{project}/regions/{region}/routers/{router}/listBgpRoutes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/routers/{router}/listBgpRoutes", "httpMethod": "GET", "parameters": { "addressFamily": { "description": "(Required) limit results to this address family (either IPv4 or IPv6)", "default": "UNSPECIFIED_IP_VERSION", "location": "query", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "IPV4", "IPV6", "UNSPECIFIED_IP_VERSION" ] }, "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 Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "peer": { "description": "(Required) limit results to the BGP peer with the given name. Name should conform to RFC1035.", "location": "query", "type": "string" }, "policyApplied": { "description": "When true, the method returns post-policy routes. Otherwise, it returns pre-policy routes.", "default": "true", "location": "query", "type": "boolean" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "routeType": { "description": "(Required) limit results to this type of route (either LEARNED or ADVERTISED)", "default": "UNSPECIFIED_ROUTE_TYPE", "location": "query", "type": "string", "enumDescriptions": [ "", "", "" ], "enum": [ "ADVERTISED", "LEARNED", "UNSPECIFIED_ROUTE_TYPE" ] }, "router": { "description": "Name or id of the resource for this request. Name should conform to RFC1035.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "router" ], "response": { "$ref": "RoutersListBgpRoutes" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of router bgp routes available to the specified project." } } }, "serviceAttachments": { "methods": { "aggregatedList": { "id": "compute.serviceAttachments.aggregatedList", "path": "projects/{project}/aggregated/serviceAttachments", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/serviceAttachments", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Name of the project scoping this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "ServiceAttachmentAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "list": { "id": "compute.serviceAttachments.list", "path": "projects/{project}/regions/{region}/serviceAttachments", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/serviceAttachments", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region of this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "ServiceAttachmentList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists the ServiceAttachments for a project in the given scope." }, "get": { "id": "compute.serviceAttachments.get", "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region of this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "serviceAttachment": { "description": "Name of the ServiceAttachment resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified ServiceAttachment resource in the given scope." }, "insert": { "id": "compute.serviceAttachments.insert", "path": "projects/{project}/regions/{region}/serviceAttachments", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/serviceAttachments", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region of this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "ServiceAttachment" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request." }, "delete": { "id": "compute.serviceAttachments.delete", "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region of this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "serviceAttachment": { "description": "Name of the ServiceAttachment resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "serviceAttachment" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified ServiceAttachment in the given scope" }, "patch": { "id": "compute.serviceAttachments.patch", "path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": 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 that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "serviceAttachment": { "description": "The resource id of the ServiceAttachment to patch. It should conform to RFC1035 resource name or be a string form on an unsigned long number.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "serviceAttachment" ], "request": { "$ref": "ServiceAttachment" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules." }, "getIamPolicy": { "id": "compute.serviceAttachments.getIamPolicy", "path": "projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.serviceAttachments.setIamPolicy", "path": "projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.serviceAttachments.testIamPermissions", "path": "projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." } } }, "snapshotSettings": { "methods": { "get": { "id": "compute.snapshotSettings.get", "path": "projects/{project}/global/snapshotSettings", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/snapshotSettings", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project" ], "response": { "$ref": "SnapshotSettings" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Get snapshot settings." }, "patch": { "id": "compute.snapshotSettings.patch", "path": "projects/{project}/global/snapshotSettings", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/snapshotSettings", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "updateMask": { "description": "update_mask indicates fields to be updated as part of this request.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "project" ], "request": { "$ref": "SnapshotSettings" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patch snapshot settings." } } }, "sslCertificates": { "methods": { "list": { "id": "compute.sslCertificates.list", "path": "projects/{project}/global/sslCertificates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/sslCertificates", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "SslCertificateList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of SslCertificate resources available to the specified project." }, "get": { "id": "compute.sslCertificates.get", "path": "projects/{project}/global/sslCertificates/{sslCertificate}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/sslCertificates/{sslCertificate}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "sslCertificate": { "description": "Name of the SslCertificate resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified SslCertificate resource." }, "insert": { "id": "compute.sslCertificates.insert", "path": "projects/{project}/global/sslCertificates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/sslCertificates", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "SslCertificate" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a SslCertificate resource in the specified project using the data included in the request." }, "delete": { "id": "compute.sslCertificates.delete", "path": "projects/{project}/global/sslCertificates/{sslCertificate}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/sslCertificates/{sslCertificate}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "sslCertificate": { "description": "Name of the SslCertificate resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "sslCertificate" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified SslCertificate resource." }, "aggregatedList": { "id": "compute.sslCertificates.aggregatedList", "path": "projects/{project}/aggregated/sslCertificates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/sslCertificates", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Name of the project scoping this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "SslCertificateAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." } } }, "regionSslCertificates": { "methods": { "list": { "id": "compute.regionSslCertificates.list", "path": "projects/{project}/regions/{region}/sslCertificates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/sslCertificates", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "SslCertificateList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of SslCertificate resources available to the specified project in the specified region." }, "get": { "id": "compute.regionSslCertificates.get", "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "sslCertificate": { "description": "Name of the SslCertificate resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request." }, "insert": { "id": "compute.regionSslCertificates.insert", "path": "projects/{project}/regions/{region}/sslCertificates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/sslCertificates", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "SslCertificate" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a SslCertificate resource in the specified project and region using the data included in the request" }, "delete": { "id": "compute.regionSslCertificates.delete", "path": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "sslCertificate": { "description": "Name of the SslCertificate resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "sslCertificate" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified SslCertificate resource in the region." } } }, "sslPolicies": { "methods": { "list": { "id": "compute.sslPolicies.list", "path": "projects/{project}/global/sslPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/sslPolicies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "SslPoliciesList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all the SSL policies that have been configured for the specified project." }, "get": { "id": "compute.sslPolicies.get", "path": "projects/{project}/global/sslPolicies/{sslPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "sslPolicy": { "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Lists all of the ordered rules present in a single specified policy." }, "insert": { "id": "compute.sslPolicies.insert", "path": "projects/{project}/global/sslPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/sslPolicies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "SslPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Returns the specified SSL policy resource." }, "delete": { "id": "compute.sslPolicies.delete", "path": "projects/{project}/global/sslPolicies/{sslPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "sslPolicy": { "description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "sslPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources." }, "patch": { "id": "compute.sslPolicies.patch", "path": "projects/{project}/global/sslPolicies/{sslPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "sslPolicy": { "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "sslPolicy" ], "request": { "$ref": "SslPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified SSL policy with the data included in the request." }, "listAvailableFeatures": { "id": "compute.sslPolicies.listAvailableFeatures", "path": "projects/{project}/global/sslPolicies/listAvailableFeatures", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/sslPolicies/listAvailableFeatures", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "SslPoliciesListAvailableFeaturesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all features that can be specified in the SSL policy when using custom profile." }, "aggregatedList": { "id": "compute.sslPolicies.aggregatedList", "path": "projects/{project}/aggregated/sslPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/sslPolicies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Name of the project scoping this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "SslPoliciesAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of all SslPolicy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." } } }, "regionSslPolicies": { "methods": { "list": { "id": "compute.regionSslPolicies.list", "path": "projects/{project}/regions/{region}/sslPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/sslPolicies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "SslPoliciesList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all the SSL policies that have been configured for the specified project and region." }, "get": { "id": "compute.regionSslPolicies.get", "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "sslPolicy": { "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Lists all of the ordered rules present in a single specified policy." }, "insert": { "id": "compute.regionSslPolicies.insert", "path": "projects/{project}/regions/{region}/sslPolicies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/sslPolicies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "SslPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a new policy in the specified project and region using the data included in the request." }, "delete": { "id": "compute.regionSslPolicies.delete", "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "sslPolicy": { "description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "sslPolicy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources." }, "patch": { "id": "compute.regionSslPolicies.patch", "path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "sslPolicy": { "description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "sslPolicy" ], "request": { "$ref": "SslPolicy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified SSL policy with the data included in the request." }, "listAvailableFeatures": { "id": "compute.regionSslPolicies.listAvailableFeatures", "path": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "SslPoliciesListAvailableFeaturesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists all features that can be specified in the SSL policy when using custom profile." } } }, "storagePoolTypes": { "methods": { "list": { "id": "compute.storagePoolTypes.list", "path": "projects/{project}/zones/{zone}/storagePoolTypes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/storagePoolTypes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "StoragePoolTypeList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of storage pool types available to the specified project." }, "aggregatedList": { "id": "compute.storagePoolTypes.aggregatedList", "path": "projects/{project}/aggregated/storagePoolTypes", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/storagePoolTypes", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "StoragePoolTypeAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of storage pool types. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.storagePoolTypes.get", "path": "projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "storagePoolType": { "description": "Name of the storage pool type to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the specified storage pool type." } } }, "storagePools": { "methods": { "list": { "id": "compute.storagePools.list", "path": "projects/{project}/zones/{zone}/storagePools", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/storagePools", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "StoragePoolList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of storage pools contained within the specified zone." }, "aggregatedList": { "id": "compute.storagePools.aggregatedList", "path": "projects/{project}/aggregated/storagePools", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/storagePools", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "StoragePoolAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of storage pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.storagePools.get", "path": "projects/{project}/zones/{zone}/storagePools/{storagePool}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "storagePool": { "description": "Name of the storage pool to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns a specified storage pool. Gets a list of available storage pools by making a list() request." }, "insert": { "id": "compute.storagePools.insert", "path": "projects/{project}/zones/{zone}/storagePools", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/storagePools", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "StoragePool" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a storage pool in the specified project using the data in the request." }, "delete": { "id": "compute.storagePools.delete", "path": "projects/{project}/zones/{zone}/storagePools/{storagePool}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "storagePool": { "description": "Name of the storage pool to delete.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "storagePool" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified storage pool. Deleting a storagePool removes its data permanently and is irreversible. However, deleting a storagePool does not delete any snapshots previously made from the storagePool. You must separately delete snapshots." }, "getIamPolicy": { "id": "compute.storagePools.getIamPolicy", "path": "projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy", "httpMethod": "GET", "parameters": { "optionsRequestedPolicyVersion": { "description": "Requested IAM Policy version.", "location": "query", "type": "integer", "format": "int32" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists." }, "setIamPolicy": { "id": "compute.storagePools.setIamPolicy", "path": "projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "request": { "$ref": "ZoneSetPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy." }, "testIamPermissions": { "id": "compute.storagePools.testIamPermissions", "path": "projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." }, "update": { "id": "compute.storagePools.update", "path": "projects/{project}/zones/{zone}/storagePools/{storagePool}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "storagePool": { "description": "The storagePool name for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "update_mask indicates fields to be updated as part of this request.", "location": "query", "type": "string", "format": "google-fieldmask" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "storagePool" ], "request": { "$ref": "StoragePool" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified storagePool with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: pool_provisioned_capacity_gb, pool_provisioned_iops and pool_provisioned_throughput." }, "listDisks": { "id": "compute.storagePools.listDisks", "path": "projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "storagePool": { "description": "Name of the storage pool to list disks of.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "The name of the zone for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "storagePool" ], "response": { "$ref": "StoragePoolListDisks" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists the disks in a specified storage pool." } } }, "targetGrpcProxies": { "methods": { "list": { "id": "compute.targetGrpcProxies.list", "path": "projects/{project}/global/targetGrpcProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetGrpcProxies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "TargetGrpcProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Lists the TargetGrpcProxies for a project in the given scope." }, "get": { "id": "compute.targetGrpcProxies.get", "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "targetGrpcProxy": { "description": "Name of the TargetGrpcProxy resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified TargetGrpcProxy resource in the given scope." }, "insert": { "id": "compute.targetGrpcProxies.insert", "path": "projects/{project}/global/targetGrpcProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetGrpcProxies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "TargetGrpcProxy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request." }, "delete": { "id": "compute.targetGrpcProxies.delete", "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetGrpcProxy": { "description": "Name of the TargetGrpcProxy resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetGrpcProxy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified TargetGrpcProxy in the given scope" }, "patch": { "id": "compute.targetGrpcProxies.patch", "path": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetGrpcProxy": { "description": "Name of the TargetGrpcProxy resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetGrpcProxy" ], "request": { "$ref": "TargetGrpcProxy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules." } } }, "targetHttpProxies": { "methods": { "list": { "id": "compute.targetHttpProxies.list", "path": "projects/{project}/global/targetHttpProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetHttpProxies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "TargetHttpProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of TargetHttpProxy resources available to the specified project." }, "get": { "id": "compute.targetHttpProxies.get", "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "targetHttpProxy": { "description": "Name of the TargetHttpProxy resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified TargetHttpProxy resource." }, "insert": { "id": "compute.targetHttpProxies.insert", "path": "projects/{project}/global/targetHttpProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetHttpProxies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "TargetHttpProxy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request." }, "delete": { "id": "compute.targetHttpProxies.delete", "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpProxy": { "description": "Name of the TargetHttpProxy resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetHttpProxy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified TargetHttpProxy resource." }, "patch": { "id": "compute.targetHttpProxies.patch", "path": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpProxy": { "description": "Name of the TargetHttpProxy resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetHttpProxy" ], "request": { "$ref": "TargetHttpProxy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules." }, "setUrlMap": { "id": "compute.targetHttpProxies.setUrlMap", "path": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpProxy": { "description": "Name of the TargetHttpProxy to set a URL map for.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetHttpProxy" ], "request": { "$ref": "UrlMapReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the URL map for TargetHttpProxy." }, "aggregatedList": { "id": "compute.targetHttpProxies.aggregatedList", "path": "projects/{project}/aggregated/targetHttpProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/targetHttpProxies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Name of the project scoping this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "TargetHttpProxyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." } } }, "regionTargetHttpProxies": { "methods": { "list": { "id": "compute.regionTargetHttpProxies.list", "path": "projects/{project}/regions/{region}/targetHttpProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetHttpProxies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "TargetHttpProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region." }, "get": { "id": "compute.regionTargetHttpProxies.get", "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "targetHttpProxy": { "description": "Name of the TargetHttpProxy resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified TargetHttpProxy resource in the specified region." }, "insert": { "id": "compute.regionTargetHttpProxies.insert", "path": "projects/{project}/regions/{region}/targetHttpProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetHttpProxies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "TargetHttpProxy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a TargetHttpProxy resource in the specified project and region using the data included in the request." }, "delete": { "id": "compute.regionTargetHttpProxies.delete", "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpProxy": { "description": "Name of the TargetHttpProxy resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetHttpProxy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified TargetHttpProxy resource." }, "setUrlMap": { "id": "compute.regionTargetHttpProxies.setUrlMap", "path": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpProxy": { "description": "Name of the TargetHttpProxy to set a URL map for.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetHttpProxy" ], "request": { "$ref": "UrlMapReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the URL map for TargetHttpProxy." } } }, "targetHttpsProxies": { "methods": { "list": { "id": "compute.targetHttpsProxies.list", "path": "projects/{project}/global/targetHttpsProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetHttpsProxies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "TargetHttpsProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project." }, "aggregatedList": { "id": "compute.targetHttpsProxies.aggregatedList", "path": "projects/{project}/aggregated/targetHttpsProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/targetHttpsProxies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Name of the project scoping this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "TargetHttpsProxyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.targetHttpsProxies.get", "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "targetHttpsProxy": { "description": "Name of the TargetHttpsProxy resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified TargetHttpsProxy resource." }, "insert": { "id": "compute.targetHttpsProxies.insert", "path": "projects/{project}/global/targetHttpsProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetHttpsProxies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "TargetHttpsProxy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request." }, "patch": { "id": "compute.targetHttpsProxies.patch", "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpsProxy": { "description": "Name of the TargetHttpsProxy resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetHttpsProxy" ], "request": { "$ref": "TargetHttpsProxy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules." }, "delete": { "id": "compute.targetHttpsProxies.delete", "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpsProxy": { "description": "Name of the TargetHttpsProxy resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetHttpsProxy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified TargetHttpsProxy resource." }, "setUrlMap": { "id": "compute.targetHttpsProxies.setUrlMap", "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpsProxy": { "description": "Name of the TargetHttpsProxy resource whose URL map is to be set.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetHttpsProxy" ], "request": { "$ref": "UrlMapReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the URL map for TargetHttpsProxy." }, "setSslCertificates": { "id": "compute.targetHttpsProxies.setSslCertificates", "path": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpsProxy": { "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetHttpsProxy" ], "request": { "$ref": "TargetHttpsProxiesSetSslCertificatesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Replaces SslCertificates for TargetHttpsProxy." }, "setCertificateMap": { "id": "compute.targetHttpsProxies.setCertificateMap", "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpsProxy": { "description": "Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetHttpsProxy" ], "request": { "$ref": "TargetHttpsProxiesSetCertificateMapRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the Certificate Map for TargetHttpsProxy." }, "setSslPolicy": { "id": "compute.targetHttpsProxies.setSslPolicy", "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpsProxy": { "description": "Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetHttpsProxy" ], "request": { "$ref": "SslPolicyReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends." }, "setQuicOverride": { "id": "compute.targetHttpsProxies.setQuicOverride", "path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpsProxy": { "description": "Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetHttpsProxy" ], "request": { "$ref": "TargetHttpsProxiesSetQuicOverrideRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the QUIC override policy for TargetHttpsProxy." } } }, "regionTargetHttpsProxies": { "methods": { "list": { "id": "compute.regionTargetHttpsProxies.list", "path": "projects/{project}/regions/{region}/targetHttpsProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "TargetHttpsProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region." }, "get": { "id": "compute.regionTargetHttpsProxies.get", "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "targetHttpsProxy": { "description": "Name of the TargetHttpsProxy resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified TargetHttpsProxy resource in the specified region." }, "insert": { "id": "compute.regionTargetHttpsProxies.insert", "path": "projects/{project}/regions/{region}/targetHttpsProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "TargetHttpsProxy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request." }, "delete": { "id": "compute.regionTargetHttpsProxies.delete", "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpsProxy": { "description": "Name of the TargetHttpsProxy resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetHttpsProxy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified TargetHttpsProxy resource." }, "patch": { "id": "compute.regionTargetHttpsProxies.patch", "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpsProxy": { "description": "Name of the TargetHttpsProxy resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetHttpsProxy" ], "request": { "$ref": "TargetHttpsProxy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules." }, "setUrlMap": { "id": "compute.regionTargetHttpsProxies.setUrlMap", "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpsProxy": { "description": "Name of the TargetHttpsProxy to set a URL map for.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetHttpsProxy" ], "request": { "$ref": "UrlMapReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the URL map for TargetHttpsProxy." }, "setSslCertificates": { "id": "compute.regionTargetHttpsProxies.setSslCertificates", "path": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetHttpsProxy": { "description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetHttpsProxy" ], "request": { "$ref": "RegionTargetHttpsProxiesSetSslCertificatesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Replaces SslCertificates for TargetHttpsProxy." } } }, "targetInstances": { "methods": { "list": { "id": "compute.targetInstances.list", "path": "projects/{project}/zones/{zone}/targetInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/targetInstances", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "zone": { "description": "Name of the zone scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "response": { "$ref": "TargetInstanceList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of TargetInstance resources available to the specified project and zone." }, "aggregatedList": { "id": "compute.targetInstances.aggregatedList", "path": "projects/{project}/aggregated/targetInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/targetInstances", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "TargetInstanceAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of target instances. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.targetInstances.get", "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "targetInstance": { "description": "Name of the TargetInstance resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Name of the zone scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "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" ], "description": "Returns the specified TargetInstance resource." }, "insert": { "id": "compute.targetInstances.insert", "path": "projects/{project}/zones/{zone}/targetInstances", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/targetInstances", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "zone": { "description": "Name of the zone scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone" ], "request": { "$ref": "TargetInstance" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request." }, "delete": { "id": "compute.targetInstances.delete", "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetInstance": { "description": "Name of the TargetInstance resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Name of the zone scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "targetInstance" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified TargetInstance resource." }, "setSecurityPolicy": { "id": "compute.targetInstances.setSecurityPolicy", "path": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetInstance": { "description": "Name of the TargetInstance resource to which the security policy should be set. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Name of the zone scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "zone", "targetInstance" ], "request": { "$ref": "SecurityPolicyReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the Google Cloud Armor security policy for the specified target instance. For more information, see Google Cloud Armor Overview" } } }, "targetPools": { "methods": { "list": { "id": "compute.targetPools.list", "path": "projects/{project}/regions/{region}/targetPools", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetPools", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "TargetPoolList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of target pools available to the specified project and region." }, "aggregatedList": { "id": "compute.targetPools.aggregatedList", "path": "projects/{project}/aggregated/targetPools", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/targetPools", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "TargetPoolAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of target pools. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.targetPools.get", "path": "projects/{project}/regions/{region}/targetPools/{targetPool}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "targetPool": { "description": "Name of the TargetPool resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified target pool." }, "insert": { "id": "compute.targetPools.insert", "path": "projects/{project}/regions/{region}/targetPools", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetPools", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "TargetPool" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a target pool in the specified project and region using the data included in the request." }, "delete": { "id": "compute.targetPools.delete", "path": "projects/{project}/regions/{region}/targetPools/{targetPool}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetPool": { "description": "Name of the TargetPool resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetPool" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified target pool." }, "getHealth": { "id": "compute.targetPools.getHealth", "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "targetPool": { "description": "Name of the TargetPool resource to which the queried instance belongs.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetPool" ], "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" ], "description": "Gets the most recent health check results for each IP for the instance that is referenced by the given target pool." }, "addHealthCheck": { "id": "compute.targetPools.addHealthCheck", "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetPool": { "description": "Name of the target pool to add a health check to.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetPool" ], "request": { "$ref": "TargetPoolsAddHealthCheckRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Adds health check URLs to a target pool." }, "removeHealthCheck": { "id": "compute.targetPools.removeHealthCheck", "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetPool": { "description": "Name of the target pool to remove health checks from.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetPool" ], "request": { "$ref": "TargetPoolsRemoveHealthCheckRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Removes health check URL from a target pool." }, "addInstance": { "id": "compute.targetPools.addInstance", "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetPool": { "description": "Name of the TargetPool resource to add instances to.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetPool" ], "request": { "$ref": "TargetPoolsAddInstanceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Adds an instance to a target pool." }, "removeInstance": { "id": "compute.targetPools.removeInstance", "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetPool": { "description": "Name of the TargetPool resource to remove instances from.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetPool" ], "request": { "$ref": "TargetPoolsRemoveInstanceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Removes instance URL from a target pool." }, "setBackup": { "id": "compute.targetPools.setBackup", "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup", "httpMethod": "POST", "parameters": { "failoverRatio": { "description": "New failoverRatio value for the target pool.", "location": "query", "type": "number", "format": "float" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetPool": { "description": "Name of the TargetPool resource to set a backup pool for.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetPool" ], "request": { "$ref": "TargetReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes a backup target pool's configurations." }, "setSecurityPolicy": { "id": "compute.targetPools.setSecurityPolicy", "path": "projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetPool": { "description": "Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetPool" ], "request": { "$ref": "SecurityPolicyReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview" } } }, "targetSslProxies": { "methods": { "list": { "id": "compute.targetSslProxies.list", "path": "projects/{project}/global/targetSslProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetSslProxies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "TargetSslProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of TargetSslProxy resources available to the specified project." }, "get": { "id": "compute.targetSslProxies.get", "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "targetSslProxy": { "description": "Name of the TargetSslProxy resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified TargetSslProxy resource." }, "insert": { "id": "compute.targetSslProxies.insert", "path": "projects/{project}/global/targetSslProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetSslProxies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "TargetSslProxy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a TargetSslProxy resource in the specified project using the data included in the request." }, "delete": { "id": "compute.targetSslProxies.delete", "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetSslProxy": { "description": "Name of the TargetSslProxy resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetSslProxy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified TargetSslProxy resource." }, "setBackendService": { "id": "compute.targetSslProxies.setBackendService", "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetSslProxy": { "description": "Name of the TargetSslProxy resource whose BackendService resource is to be set.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetSslProxy" ], "request": { "$ref": "TargetSslProxiesSetBackendServiceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the BackendService for TargetSslProxy." }, "setSslCertificates": { "id": "compute.targetSslProxies.setSslCertificates", "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetSslProxy": { "description": "Name of the TargetSslProxy resource whose SslCertificate resource is to be set.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetSslProxy" ], "request": { "$ref": "TargetSslProxiesSetSslCertificatesRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes SslCertificates for TargetSslProxy." }, "setCertificateMap": { "id": "compute.targetSslProxies.setCertificateMap", "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetSslProxy": { "description": "Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetSslProxy" ], "request": { "$ref": "TargetSslProxiesSetCertificateMapRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the Certificate Map for TargetSslProxy." }, "setProxyHeader": { "id": "compute.targetSslProxies.setProxyHeader", "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetSslProxy": { "description": "Name of the TargetSslProxy resource whose ProxyHeader is to be set.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetSslProxy" ], "request": { "$ref": "TargetSslProxiesSetProxyHeaderRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the ProxyHeaderType for TargetSslProxy." }, "setSslPolicy": { "id": "compute.targetSslProxies.setSslPolicy", "path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetSslProxy": { "description": "Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetSslProxy" ], "request": { "$ref": "SslPolicyReference" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the load balancer. They do not affect the connection between the load balancer and the backends." } } }, "targetTcpProxies": { "methods": { "list": { "id": "compute.targetTcpProxies.list", "path": "projects/{project}/global/targetTcpProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetTcpProxies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "TargetTcpProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of TargetTcpProxy resources available to the specified project." }, "aggregatedList": { "id": "compute.targetTcpProxies.aggregatedList", "path": "projects/{project}/aggregated/targetTcpProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/targetTcpProxies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Name of the project scoping this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "TargetTcpProxyAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.targetTcpProxies.get", "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "targetTcpProxy": { "description": "Name of the TargetTcpProxy resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified TargetTcpProxy resource." }, "insert": { "id": "compute.targetTcpProxies.insert", "path": "projects/{project}/global/targetTcpProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetTcpProxies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "TargetTcpProxy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a TargetTcpProxy resource in the specified project using the data included in the request." }, "delete": { "id": "compute.targetTcpProxies.delete", "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetTcpProxy": { "description": "Name of the TargetTcpProxy resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetTcpProxy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified TargetTcpProxy resource." }, "setBackendService": { "id": "compute.targetTcpProxies.setBackendService", "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetTcpProxy": { "description": "Name of the TargetTcpProxy resource whose BackendService resource is to be set.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetTcpProxy" ], "request": { "$ref": "TargetTcpProxiesSetBackendServiceRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the BackendService for TargetTcpProxy." }, "setProxyHeader": { "id": "compute.targetTcpProxies.setProxyHeader", "path": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetTcpProxy": { "description": "Name of the TargetTcpProxy resource whose ProxyHeader is to be set.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "targetTcpProxy" ], "request": { "$ref": "TargetTcpProxiesSetProxyHeaderRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Changes the ProxyHeaderType for TargetTcpProxy." } } }, "regionTargetTcpProxies": { "methods": { "list": { "id": "compute.regionTargetTcpProxies.list", "path": "projects/{project}/regions/{region}/targetTcpProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetTcpProxies", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "TargetTcpProxyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of TargetTcpProxy resources available to the specified project in a given region." }, "get": { "id": "compute.regionTargetTcpProxies.get", "path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "targetTcpProxy": { "description": "Name of the TargetTcpProxy resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified TargetTcpProxy resource." }, "insert": { "id": "compute.regionTargetTcpProxies.insert", "path": "projects/{project}/regions/{region}/targetTcpProxies", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetTcpProxies", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "TargetTcpProxy" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a TargetTcpProxy resource in the specified project and region using the data included in the request." }, "delete": { "id": "compute.regionTargetTcpProxies.delete", "path": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetTcpProxy": { "description": "Name of the TargetTcpProxy resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetTcpProxy" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified TargetTcpProxy resource." } } }, "targetVpnGateways": { "methods": { "list": { "id": "compute.targetVpnGateways.list", "path": "projects/{project}/regions/{region}/targetVpnGateways", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetVpnGateways", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "TargetVpnGatewayList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of target VPN gateways available to the specified project and region." }, "aggregatedList": { "id": "compute.targetVpnGateways.aggregatedList", "path": "projects/{project}/aggregated/targetVpnGateways", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/targetVpnGateways", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "TargetVpnGatewayAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of target VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.targetVpnGateways.get", "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "targetVpnGateway": { "description": "Name of the target VPN gateway to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified target VPN gateway." }, "insert": { "id": "compute.targetVpnGateways.insert", "path": "projects/{project}/regions/{region}/targetVpnGateways", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetVpnGateways", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "TargetVpnGateway" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a target VPN gateway in the specified project and region using the data included in the request." }, "delete": { "id": "compute.targetVpnGateways.delete", "path": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "targetVpnGateway": { "description": "Name of the target VPN gateway to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "targetVpnGateway" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified target VPN gateway." }, "setLabels": { "id": "compute.targetVpnGateways.setLabels", "path": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation." } } }, "urlMaps": { "methods": { "list": { "id": "compute.urlMaps.list", "path": "projects/{project}/global/urlMaps", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/urlMaps", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "UrlMapList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of UrlMap resources available to the specified project." }, "aggregatedList": { "id": "compute.urlMaps.aggregatedList", "path": "projects/{project}/aggregated/urlMaps", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/urlMaps", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Name of the project scoping this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "UrlMapsAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.urlMaps.get", "path": "projects/{project}/global/urlMaps/{urlMap}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/urlMaps/{urlMap}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "urlMap": { "description": "Name of the UrlMap resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified UrlMap resource." }, "insert": { "id": "compute.urlMaps.insert", "path": "projects/{project}/global/urlMaps", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/urlMaps", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project" ], "request": { "$ref": "UrlMap" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a UrlMap resource in the specified project using the data included in the request." }, "delete": { "id": "compute.urlMaps.delete", "path": "projects/{project}/global/urlMaps/{urlMap}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/urlMaps/{urlMap}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "urlMap": { "description": "Name of the UrlMap resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "urlMap" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified UrlMap resource." }, "update": { "id": "compute.urlMaps.update", "path": "projects/{project}/global/urlMaps/{urlMap}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/urlMaps/{urlMap}", "httpMethod": "PUT", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "urlMap": { "description": "Name of the UrlMap resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "urlMap" ], "request": { "$ref": "UrlMap" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified UrlMap resource with the data included in the request." }, "patch": { "id": "compute.urlMaps.patch", "path": "projects/{project}/global/urlMaps/{urlMap}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/urlMaps/{urlMap}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "urlMap": { "description": "Name of the UrlMap resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "urlMap" ], "request": { "$ref": "UrlMap" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules." }, "validate": { "id": "compute.urlMaps.validate", "path": "projects/{project}/global/urlMaps/{urlMap}/validate", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/urlMaps/{urlMap}/validate", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "urlMap": { "description": "Name of the UrlMap resource to be validated as.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "urlMap" ], "request": { "$ref": "UrlMapsValidateRequest" }, "response": { "$ref": "UrlMapsValidateResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap." }, "invalidateCache": { "id": "compute.urlMaps.invalidateCache", "path": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "urlMap": { "description": "Name of the UrlMap scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "urlMap" ], "request": { "$ref": "CacheInvalidationRule" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](\/cdn\/docs\/invalidating-cached-content)." } } }, "regionUrlMaps": { "methods": { "list": { "id": "compute.regionUrlMaps.list", "path": "projects/{project}/regions/{region}/urlMaps", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/urlMaps", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "UrlMapList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of UrlMap resources available to the specified project in the specified region." }, "get": { "id": "compute.regionUrlMaps.get", "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "urlMap": { "description": "Name of the UrlMap resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified UrlMap resource." }, "insert": { "id": "compute.regionUrlMaps.insert", "path": "projects/{project}/regions/{region}/urlMaps", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/urlMaps", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "UrlMap" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a UrlMap resource in the specified project using the data included in the request." }, "delete": { "id": "compute.regionUrlMaps.delete", "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", "location": "query", "type": "string" }, "urlMap": { "description": "Name of the UrlMap resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "urlMap" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified UrlMap resource." }, "update": { "id": "compute.regionUrlMaps.update", "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "httpMethod": "PUT", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", "location": "query", "type": "string" }, "urlMap": { "description": "Name of the UrlMap resource to update.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "urlMap" ], "request": { "$ref": "UrlMap" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Updates the specified UrlMap resource with the data included in the request." }, "patch": { "id": "compute.regionUrlMaps.patch", "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}", "httpMethod": "PATCH", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.", "location": "query", "type": "string" }, "urlMap": { "description": "Name of the UrlMap resource to patch.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "urlMap" ], "request": { "$ref": "UrlMap" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules." }, "validate": { "id": "compute.regionUrlMaps.validate", "path": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region scoping this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "urlMap": { "description": "Name of the UrlMap resource to be validated as.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "urlMap" ], "request": { "$ref": "RegionUrlMapsValidateRequest" }, "response": { "$ref": "UrlMapsValidateResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap." } } }, "vpnGateways": { "methods": { "list": { "id": "compute.vpnGateways.list", "path": "projects/{project}/regions/{region}/vpnGateways", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/vpnGateways", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "VpnGatewayList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of VPN gateways available to the specified project and region." }, "aggregatedList": { "id": "compute.vpnGateways.aggregatedList", "path": "projects/{project}/aggregated/vpnGateways", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/vpnGateways", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "VpnGatewayAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of VPN gateways. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.vpnGateways.get", "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "vpnGateway": { "description": "Name of the VPN gateway to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified VPN gateway." }, "getStatus": { "id": "compute.vpnGateways.getStatus", "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "vpnGateway": { "description": "Name of the VPN gateway to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "vpnGateway" ], "response": { "$ref": "VpnGatewaysGetStatusResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Returns the status for the specified VPN gateway." }, "insert": { "id": "compute.vpnGateways.insert", "path": "projects/{project}/regions/{region}/vpnGateways", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/vpnGateways", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "VpnGateway" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a VPN gateway in the specified project and region using the data included in the request." }, "delete": { "id": "compute.vpnGateways.delete", "path": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "vpnGateway": { "description": "Name of the VPN gateway to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "vpnGateway" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified VPN gateway." }, "testIamPermissions": { "id": "compute.vpnGateways.testIamPermissions", "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "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" ], "description": "Returns permissions that a caller has on the specified resource." }, "setLabels": { "id": "compute.vpnGateways.setLabels", "path": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation." } } }, "vpnTunnels": { "methods": { "list": { "id": "compute.vpnTunnels.list", "path": "projects/{project}/regions/{region}/vpnTunnels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/vpnTunnels", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "VpnTunnelList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves a list of VpnTunnel resources contained in the specified project and region." }, "aggregatedList": { "id": "compute.vpnTunnels.aggregatedList", "path": "projects/{project}/aggregated/vpnTunnels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/aggregated/vpnTunnels", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "includeAllScopes": { "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", "location": "query", "type": "boolean" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" }, "serviceProjectNumber": { "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", "location": "query", "type": "string", "format": "int64" } }, "parameterOrder": [ "project" ], "response": { "$ref": "VpnTunnelAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves an aggregated list of VPN tunnels. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`." }, "get": { "id": "compute.vpnTunnels.get", "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "vpnTunnel": { "description": "Name of the VpnTunnel resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "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" ], "description": "Returns the specified VpnTunnel resource." }, "insert": { "id": "compute.vpnTunnels.insert", "path": "projects/{project}/regions/{region}/vpnTunnels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/vpnTunnels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "project", "region" ], "request": { "$ref": "VpnTunnel" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Creates a VpnTunnel resource in the specified project and region using the data included in the request." }, "delete": { "id": "compute.vpnTunnels.delete", "path": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}", "httpMethod": "DELETE", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Name of the region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "vpnTunnel": { "description": "Name of the VpnTunnel resource to delete.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "vpnTunnel" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Deletes the specified VpnTunnel resource." }, "setLabels": { "id": "compute.vpnTunnels.setLabels", "path": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels", "httpMethod": "POST", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "The region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "resource": { "description": "Name or id of the resource for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "region", "resource" ], "request": { "$ref": "RegionSetLabelsRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], "description": "Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation." } } }, "zones": { "methods": { "list": { "id": "compute.zones.list", "path": "projects/{project}/zones", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project" ], "response": { "$ref": "ZoneList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of Zone resources available to the specified project." }, "get": { "id": "compute.zones.get", "path": "projects/{project}/zones/{zone}", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/zones/{zone}", "httpMethod": "GET", "parameters": { "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "zone": { "description": "Name of the zone resource to return.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?\|[1-9][0-9]{0,19}", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "project", "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" ], "description": "Returns the specified Zone resource." } } }, "regionZones": { "methods": { "list": { "id": "compute.regionZones.list", "path": "projects/{project}/regions/{region}/zones", "apiVersion": "2024-12-01", "flatPath": "projects/{project}/regions/{region}/zones", "httpMethod": "GET", "parameters": { "filter": { "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, "maxResults": { "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", "default": "500", "minimum": "0", "location": "query", "type": "integer", "format": "uint32" }, "orderBy": { "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", "location": "query", "type": "string" }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" }, "project": { "description": "Project ID for this request.", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}\|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "location": "path", "required": true, "type": "string" }, "region": { "description": "Region for this request.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "location": "path", "required": true, "type": "string" }, "returnPartialSuccess": { "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "project", "region" ], "response": { "$ref": "ZoneList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ], "description": "Retrieves the list of Zone resources under the specific region available to the specified project." } } } }, "basePath": "/compute/" }	4.71 MB	2025-03-11 18:02

Terminal