mudhorn/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2024-12-30 07:59:40 -08:00
Code Issues Actions 10 Packages Projects Releases Wiki Activity
prometheus/vendor/google.golang.org/api/compute/v1/compute-api.json
Ingo Gottwald fefcd6eef2 Add deps for google cloud support
2016-09-16 08:51:58 +02:00

14570 lines
583 KiB
JSON
Raw Blame History

{
"kind": "discovery#restDescription",
"etag": "\"jQLIOHBVnDZie4rQHGH1WJF-INE/EHCe447NNFzcuEzJ3q8xwd99R4Q\"",
"discoveryVersion": "v1",
"id": "compute:v1",
"name": "compute",
"version": "v1",
"revision": "20160509",
"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://developers.google.com/compute/docs/reference/latest/",
"protocol": "rest",
"baseUrl": "https://www.googleapis.com/compute/v1/projects/",
"basePath": "/compute/v1/projects/",
"rootUrl": "https://www.googleapis.com/",
"servicePath": "compute/v1/projects/",
"batchPath": "batch",
"parameters": {
"alt": {
"type": "string",
"description": "Data format for the response.",
"default": "json",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"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. Overrides userIp if both are provided.",
"location": "query"
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
"location": "query"
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/compute": {
"description": "View and manage your Google Compute Engine resources"
},
"https://www.googleapis.com/auth/compute.readonly": {
"description": "View your Google Compute Engine resources"
},
"https://www.googleapis.com/auth/devstorage.full_control": {
"description": "Manage your data and permissions in Google Cloud Storage"
},
"https://www.googleapis.com/auth/devstorage.read_only": {
"description": "View your data in Google Cloud Storage"
},
"https://www.googleapis.com/auth/devstorage.read_write": {
"description": "Manage your data in Google Cloud Storage"
}
}
}
},
"schemas": {
"AccessConfig": {
"id": "AccessConfig",
"type": "object",
"description": "An access configuration attached to an instance's network interface.",
"properties": {
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#accessConfig for access configs.",
"default": "compute#accessConfig"
},
"name": {
"type": "string",
"description": "Name of this access configuration."
},
"natIP": {
"type": "string",
"description": "An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance."
},
"type": {
"type": "string",
"description": "The type of configuration. The default and only option is ONE_TO_ONE_NAT.",
"default": "ONE_TO_ONE_NAT",
"enum": [
"ONE_TO_ONE_NAT"
],
"enumDescriptions": [
""
]
}
}
},
"Address": {
"id": "Address",
"type": "object",
"description": "A reserved address resource.",
"properties": {
"address": {
"type": "string",
"description": "The static external IP address represented by this resource."
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#address for addresses.",
"default": "compute#address"
},
"name": {
"type": "string",
"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.addresses.insert"
]
}
},
"region": {
"type": "string",
"description": "[Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"status": {
"type": "string",
"description": "[Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.",
"enum": [
"IN_USE",
"RESERVED"
],
"enumDescriptions": [
"",
""
]
},
"users": {
"type": "array",
"description": "[Output Only] The URLs of the resources that are using this address.",
"items": {
"type": "string"
}
}
}
},
"AddressAggregatedList": {
"id": "AddressAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] Unique identifier for the resource; defined by the server."
},
"items": {
"type": "object",
"description": "[Output Only] A map of scoped address lists.",
"additionalProperties": {
"$ref": "AddressesScopedList",
"description": "[Output Only] Name of the scope containing this set of addresses."
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.",
"default": "compute#addressAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"AddressList": {
"id": "AddressList",
"type": "object",
"description": "Contains a list of addresses.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of addresses.",
"items": {
"$ref": "Address"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#addressList for lists of addresses.",
"default": "compute#addressList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
}
}
},
"AddressesScopedList": {
"id": "AddressesScopedList",
"type": "object",
"properties": {
"addresses": {
"type": "array",
"description": "[Output Only] List of addresses contained in this scope.",
"items": {
"$ref": "Address"
}
},
"warning": {
"type": "object",
"description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"AttachedDisk": {
"id": "AttachedDisk",
"type": "object",
"description": "An instance-attached disk resource.",
"properties": {
"autoDelete": {
"type": "boolean",
"description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance)."
},
"boot": {
"type": "boolean",
"description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem."
},
"deviceName": {
"type": "string",
"description": "Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.\n\nIf not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks."
},
"index": {
"type": "integer",
"description": "Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.",
"format": "int32"
},
"initializeParams": {
"$ref": "AttachedDiskInitializeParams",
"description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.\n\nThis property is mutually exclusive with the source property; you can only define one or the other, but not both."
},
"interface": {
"type": "string",
"description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.",
"enum": [
"NVME",
"SCSI"
],
"enumDescriptions": [
"",
""
]
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.",
"default": "compute#attachedDisk"
},
"licenses": {
"type": "array",
"description": "[Output Only] Any valid publicly visible licenses.",
"items": {
"type": "string"
}
},
"mode": {
"type": "string",
"description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.",
"enum": [
"READ_ONLY",
"READ_WRITE"
],
"enumDescriptions": [
"",
""
]
},
"source": {
"type": "string",
"description": "Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks."
},
"type": {
"type": "string",
"description": "Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.",
"enum": [
"PERSISTENT",
"SCRATCH"
],
"enumDescriptions": [
"",
""
],
"annotations": {
"required": [
"compute.instances.insert"
]
}
}
}
},
"AttachedDiskInitializeParams": {
"id": "AttachedDiskInitializeParams",
"type": "object",
"description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.\n\nThis property is mutually exclusive with the source property; you can only define one or the other, but not both.",
"properties": {
"diskName": {
"type": "string",
"description": "Specifies the disk name. If not specified, the default is to use the name of the instance."
},
"diskSizeGb": {
"type": "string",
"description": "Specifies the size of the disk in base-2 GB.",
"format": "int64"
},
"diskType": {
"type": "string",
"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:\n\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard \n\nOther values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType \n- projects/project/zones/zone/diskTypes/diskType \n- zones/zone/diskTypes/diskType"
},
"sourceImage": {
"type": "string",
"description": "The source image used to create this disk. If the source image is deleted, this field will not be set.\n\nTo create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:\n\nprojects/debian-cloud/global/images/family/debian-8 \n\nAlternatively, use a specific version of a public operating system image:\n\nprojects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD \n\nTo create a disk with a private image that you created, specify the image name in the following format:\n\nglobal/images/my-private-image \n\nYou can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:\n\nglobal/images/family/my-private-family"
}
}
},
"Autoscaler": {
"id": "Autoscaler",
"type": "object",
"description": "Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances.",
"properties": {
"autoscalingPolicy": {
"$ref": "AutoscalingPolicy",
"description": "The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.\n\nIf none of these are specified, the default will be to autoscale based on cpuUtilization to 0.8 or 80%."
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.",
"default": "compute#autoscaler"
},
"name": {
"type": "string",
"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.instanceGroups.insert"
]
}
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"target": {
"type": "string",
"description": "URL of the managed instance group that this autoscaler will scale."
},
"zone": {
"type": "string",
"description": "[Output Only] URL of the zone where the instance group resides."
}
}
},
"AutoscalerAggregatedList": {
"id": "AutoscalerAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "object",
"description": "A map of scoped autoscaler lists.",
"additionalProperties": {
"$ref": "AutoscalersScopedList",
"description": "[Output Only] Name of the scope containing this set of autoscalers."
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.",
"default": "compute#autoscalerAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"AutoscalerList": {
"id": "AutoscalerList",
"type": "object",
"description": "Contains a list of Autoscaler resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "A list of Autoscaler resources.",
"items": {
"$ref": "Autoscaler"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.",
"default": "compute#autoscalerList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"AutoscalersScopedList": {
"id": "AutoscalersScopedList",
"type": "object",
"properties": {
"autoscalers": {
"type": "array",
"description": "[Output Only] List of autoscalers contained in this scope.",
"items": {
"$ref": "Autoscaler"
}
},
"warning": {
"type": "object",
"description": "[Output Only] Informational warning which replaces the list of autoscalers when the list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"AutoscalingPolicy": {
"id": "AutoscalingPolicy",
"type": "object",
"description": "Cloud Autoscaler policy.",
"properties": {
"coolDownPeriodSec": {
"type": "integer",
"description": "The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.",
"format": "int32"
},
"cpuUtilization": {
"$ref": "AutoscalingPolicyCpuUtilization",
"description": "Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group."
},
"customMetricUtilizations": {
"type": "array",
"description": "Configuration parameters of autoscaling based on a custom metric.",
"items": {
"$ref": "AutoscalingPolicyCustomMetricUtilization"
}
},
"loadBalancingUtilization": {
"$ref": "AutoscalingPolicyLoadBalancingUtilization",
"description": "Configuration parameters of autoscaling based on load balancer."
},
"maxNumReplicas": {
"type": "integer",
"description": "The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.",
"format": "int32"
},
"minNumReplicas": {
"type": "integer",
"description": "The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.",
"format": "int32"
}
}
},
"AutoscalingPolicyCpuUtilization": {
"id": "AutoscalingPolicyCpuUtilization",
"type": "object",
"description": "CPU utilization policy.",
"properties": {
"utilizationTarget": {
"type": "number",
"description": "The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.8.\n\nIf the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.\n\nIf the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.",
"format": "double"
}
}
},
"AutoscalingPolicyCustomMetricUtilization": {
"id": "AutoscalingPolicyCustomMetricUtilization",
"type": "object",
"description": "Custom utilization metric policy.",
"properties": {
"metric": {
"type": "string",
"description": "The identifier of the Cloud Monitoring metric. The metric cannot have negative values and should be a utilization metric, which means that the number of virtual machines handling requests should increase or decrease proportionally to the metric. The metric must also have a label of compute.googleapis.com/resource_id with the value of the instance's unique ID, although this alone does not guarantee that the metric is valid.\n\nFor example, the following is a valid metric:\ncompute.googleapis.com/instance/network/received_bytes_count\n\n\nThe following is not a valid metric because it does not increase or decrease based on usage:\ncompute.googleapis.com/instance/cpu/reserved_cores"
},
"utilizationTarget": {
"type": "number",
"description": "Target value of the metric which autoscaler should maintain. Must be a positive value.",
"format": "double"
},
"utilizationTargetType": {
"type": "string",
"description": "Defines how target utilization value is expressed for a Cloud Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE. If not specified, the default is GAUGE.",
"enum": [
"DELTA_PER_MINUTE",
"DELTA_PER_SECOND",
"GAUGE"
],
"enumDescriptions": [
"",
"",
""
]
}
}
},
"AutoscalingPolicyLoadBalancingUtilization": {
"id": "AutoscalingPolicyLoadBalancingUtilization",
"type": "object",
"description": "Configuration parameters of autoscaling based on load balancing.",
"properties": {
"utilizationTarget": {
"type": "number",
"description": "Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.",
"format": "double"
}
}
},
"Backend": {
"id": "Backend",
"type": "object",
"description": "Message containing information of one individual backend.",
"properties": {
"balancingMode": {
"type": "string",
"description": "Specifies the balancing mode for this backend. For global HTTP(S) load balancing, the default is UTILIZATION. Valid values are UTILIZATION and RATE.",
"enum": [
"RATE",
"UTILIZATION"
],
"enumDescriptions": [
"",
""
]
},
"capacityScaler": {
"type": "number",
"description": "A multiplier applied to the group's maximum servicing capacity (either UTILIZATION or RATE). Default value is 1, which means the group will serve up to 100% of its configured CPU or RPS (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available CPU or RPS. Valid range is [0.0,1.0].",
"format": "float"
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"group": {
"type": "string",
"description": "The fully-qualified URL of a zonal Instance Group resource. This instance group defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource.\n\nNote that you must specify an Instance Group resource using the fully-qualified URL, rather than a partial URL."
},
"maxRate": {
"type": "integer",
"description": "The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or maxRatePerInstance must be set.",
"format": "int32"
},
"maxRatePerInstance": {
"type": "number",
"description": "The max requests per second (RPS) that a single backend instance can handle.This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.",
"format": "float"
},
"maxUtilization": {
"type": "number",
"description": "Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].",
"format": "float"
}
}
},
"BackendService": {
"id": "BackendService",
"type": "object",
"description": "A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.",
"properties": {
"backends": {
"type": "array",
"description": "The list of backends that serve this BackendService.",
"items": {
"$ref": "Backend"
}
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"fingerprint": {
"type": "string",
"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.",
"format": "byte"
},
"healthChecks": {
"type": "array",
"description": "The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required.",
"items": {
"type": "string"
}
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#backendService for backend services.",
"default": "compute#backendService"
},
"name": {
"type": "string",
"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])?"
},
"port": {
"type": "integer",
"description": "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.",
"format": "int32"
},
"portName": {
"type": "string",
"description": "Name of backend port. The same name should appear in the instance groups referenced by this service. Required."
},
"protocol": {
"type": "string",
"description": "The protocol this BackendService uses to communicate with backends.\n\nPossible values are HTTP, HTTPS, HTTP2, TCP and SSL.",
"enum": [
"HTTP",
"HTTPS"
],
"enumDescriptions": [
"",
""
]
},
"region": {
"type": "string",
"description": "[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"timeoutSec": {
"type": "integer",
"description": "How many seconds to wait for the backend before considering it a failed request. Default is 30 seconds.",
"format": "int32"
}
}
},
"BackendServiceGroupHealth": {
"id": "BackendServiceGroupHealth",
"type": "object",
"properties": {
"healthStatus": {
"type": "array",
"items": {
"$ref": "HealthStatus"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.",
"default": "compute#backendServiceGroupHealth"
}
}
},
"BackendServiceList": {
"id": "BackendServiceList",
"type": "object",
"description": "Contains a list of BackendService resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "A list of BackendService resources.",
"items": {
"$ref": "BackendService"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.",
"default": "compute#backendServiceList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"DeprecationStatus": {
"id": "DeprecationStatus",
"type": "object",
"description": "Deprecation status for a public resource.",
"properties": {
"deleted": {
"type": "string",
"description": "An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED."
},
"deprecated": {
"type": "string",
"description": "An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED."
},
"obsolete": {
"type": "string",
"description": "An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE."
},
"replacement": {
"type": "string",
"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."
},
"state": {
"type": "string",
"description": "The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.",
"enum": [
"DELETED",
"DEPRECATED",
"OBSOLETE"
],
"enumDescriptions": [
"",
"",
""
]
}
}
},
"Disk": {
"id": "Disk",
"type": "object",
"description": "A Disk resource.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#disk for disks.",
"default": "compute#disk"
},
"lastAttachTimestamp": {
"type": "string",
"description": "[Output Only] Last attach timestamp in RFC3339 text format."
},
"lastDetachTimestamp": {
"type": "string",
"description": "[Output Only] Last detach timestamp in RFC3339 text format."
},
"licenses": {
"type": "array",
"description": "[Output Only] Any applicable publicly visible licenses.",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"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"
]
}
},
"options": {
"type": "string",
"description": "Internal use only."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined fully-qualified URL for this resource."
},
"sizeGb": {
"type": "string",
"description": "Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.\n\nIf you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.",
"format": "int64"
},
"sourceImage": {
"type": "string",
"description": "The source image used to create this disk. If the source image is deleted, this field will not be set.\n\nTo create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:\n\nprojects/debian-cloud/global/images/family/debian-8 \n\nAlternatively, use a specific version of a public operating system image:\n\nprojects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD \n\nTo create a disk with a private image that you created, specify the image name in the following format:\n\nglobal/images/my-private-image \n\nYou can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:\n\nglobal/images/family/my-private-family"
},
"sourceImageId": {
"type": "string",
"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."
},
"sourceSnapshot": {
"type": "string",
"description": "The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: \n- https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot \n- projects/project/global/snapshots/snapshot \n- global/snapshots/snapshot"
},
"sourceSnapshotId": {
"type": "string",
"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."
},
"status": {
"type": "string",
"description": "[Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.",
"enum": [
"CREATING",
"FAILED",
"READY",
"RESTORING"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"type": {
"type": "string",
"description": "URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk."
},
"users": {
"type": "array",
"description": "[Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance",
"items": {
"type": "string"
}
},
"zone": {
"type": "string",
"description": "[Output Only] URL of the zone where the disk resides."
}
}
},
"DiskAggregatedList": {
"id": "DiskAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "object",
"description": "[Output Only] A map of scoped disk lists.",
"additionalProperties": {
"$ref": "DisksScopedList",
"description": "[Output Only] Name of the scope containing this set of disks."
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.",
"default": "compute#diskAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"DiskList": {
"id": "DiskList",
"type": "object",
"description": "A list of Disk resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of persistent disks.",
"items": {
"$ref": "Disk"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#diskList for lists of disks.",
"default": "compute#diskList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"DiskMoveRequest": {
"id": "DiskMoveRequest",
"type": "object",
"properties": {
"destinationZone": {
"type": "string",
"description": "The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone \n- projects/project/zones/zone \n- zones/zone"
},
"targetDisk": {
"type": "string",
"description": "The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk \n- projects/project/zones/zone/disks/disk \n- zones/zone/disks/disk"
}
}
},
"DiskType": {
"id": "DiskType",
"type": "object",
"description": "A DiskType resource.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"defaultDiskSizeGb": {
"type": "string",
"description": "[Output Only] Server-defined default disk size in GB.",
"format": "int64"
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "[Output Only] The deprecation status associated with this disk type."
},
"description": {
"type": "string",
"description": "[Output Only] An optional description of this resource."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#diskType for disk types.",
"default": "compute#diskType"
},
"name": {
"type": "string",
"description": "[Output Only] Name of the resource.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"validDiskSize": {
"type": "string",
"description": "[Output Only] An optional textual description of the valid disk size, such as \"10GB-10TB\"."
},
"zone": {
"type": "string",
"description": "[Output Only] URL of the zone where the disk type resides."
}
}
},
"DiskTypeAggregatedList": {
"id": "DiskTypeAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "object",
"description": "[Output Only] A map of scoped disk type lists.",
"additionalProperties": {
"$ref": "DiskTypesScopedList",
"description": "[Output Only] Name of the scope containing this set of disk types."
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#diskTypeAggregatedList.",
"default": "compute#diskTypeAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"DiskTypeList": {
"id": "DiskTypeList",
"type": "object",
"description": "Contains a list of disk types.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of Disk Type resources.",
"items": {
"$ref": "DiskType"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#diskTypeList for disk types.",
"default": "compute#diskTypeList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"DiskTypesScopedList": {
"id": "DiskTypesScopedList",
"type": "object",
"properties": {
"diskTypes": {
"type": "array",
"description": "[Output Only] List of disk types contained in this scope.",
"items": {
"$ref": "DiskType"
}
},
"warning": {
"type": "object",
"description": "[Output Only] Informational warning which replaces the list of disk types when the list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"DisksResizeRequest": {
"id": "DisksResizeRequest",
"type": "object",
"properties": {
"sizeGb": {
"type": "string",
"description": "The new size of the persistent disk, which is specified in GB.",
"format": "int64"
}
}
},
"DisksScopedList": {
"id": "DisksScopedList",
"type": "object",
"properties": {
"disks": {
"type": "array",
"description": "[Output Only] List of disks contained in this scope.",
"items": {
"$ref": "Disk"
}
},
"warning": {
"type": "object",
"description": "[Output Only] Informational warning which replaces the list of disks when the list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"Firewall": {
"id": "Firewall",
"type": "object",
"description": "Represents a Firewall resource.",
"properties": {
"allowed": {
"type": "array",
"description": "The list of rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.",
"items": {
"type": "object",
"properties": {
"IPProtocol": {
"type": "string",
"description": "The IP protocol that is allowed for this rule. 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, sctp), or the IP protocol number."
},
"ports": {
"type": "array",
"description": "An optional list of ports which are allowed. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, connections through any port are allowed\n\nExample inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].",
"items": {
"type": "string"
}
}
}
}
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Ony] Type of the resource. Always compute#firewall for firewall rules.",
"default": "compute#firewall"
},
"name": {
"type": "string",
"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.firewalls.insert",
"compute.firewalls.patch"
]
}
},
"network": {
"type": "string",
"description": "URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:\nglobal/networks/default\nIf you choose to specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network \n- projects/myproject/global/networks/my-network \n- global/networks/default"
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"sourceRanges": {
"type": "array",
"description": "The IP address blocks that this rule applies to, expressed in CIDR format. One or both of sourceRanges and sourceTags may be set.\n\nIf both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.",
"items": {
"type": "string"
}
},
"sourceTags": {
"type": "array",
"description": "A list of instance tags which this rule applies to. One or both of sourceRanges and sourceTags may be set.\n\nIf both properties are set, an inbound connection is allowed if the range matches the sourceRanges OR the tag of the source matches the sourceTags property. The connection does not need to match both properties.\n\nSource tags cannot be used to allow access to an instance's external IP address. Because tags are associated with an instance, not an IP address, source tags can only be used to control traffic traveling from an instance inside the same network as the firewall.",
"items": {
"type": "string"
}
},
"targetTags": {
"type": "array",
"description": "A list of instance tags indicating sets of instances located in the network that may make network connections as specified in allowed[]. If no targetTags are specified, the firewall rule applies to all instances on the specified network.",
"items": {
"type": "string"
}
}
}
},
"FirewallList": {
"id": "FirewallList",
"type": "object",
"description": "Contains a list of firewalls.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of Firewall resources.",
"items": {
"$ref": "Firewall"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#firewallList for lists of firewalls.",
"default": "compute#firewallList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"ForwardingRule": {
"id": "ForwardingRule",
"type": "object",
"description": "A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.",
"properties": {
"IPAddress": {
"type": "string",
"description": "Value of the reserved IP address that this forwarding rule is serving on behalf of. For global forwarding rules, the address must be a global IP; for regional forwarding rules, the address must live in the same region as the forwarding rule. If left empty (default value), an ephemeral IP from the same scope (global or regional) will be assigned."
},
"IPProtocol": {
"type": "string",
"description": "The IP protocol to which this rule applies. Valid options are TCP, UDP, ESP, AH, SCTP or ICMP.",
"enum": [
"AH",
"ESP",
"SCTP",
"TCP",
"UDP"
],
"enumDescriptions": [
"",
"",
"",
"",
""
]
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.",
"default": "compute#forwardingRule"
},
"name": {
"type": "string",
"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])?"
},
"portRange": {
"type": "string",
"description": "Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges."
},
"region": {
"type": "string",
"description": "[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"target": {
"type": "string",
"description": "The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global TargetHttpProxy or TargetHttpsProxy resource. The forwarded traffic must be of a type appropriate to the target object. For example, TargetHttpProxy requires HTTP traffic, and TargetHttpsProxy requires HTTPS traffic."
}
}
},
"ForwardingRuleAggregatedList": {
"id": "ForwardingRuleAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "object",
"description": "A map of scoped forwarding rule lists.",
"additionalProperties": {
"$ref": "ForwardingRulesScopedList",
"description": "Name of the scope containing this set of addresses."
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.",
"default": "compute#forwardingRuleAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"ForwardingRuleList": {
"id": "ForwardingRuleList",
"type": "object",
"description": "Contains a list of ForwardingRule resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] Unique identifier for the resource. Set by the server."
},
"items": {
"type": "array",
"description": "A list of ForwardingRule resources.",
"items": {
"$ref": "ForwardingRule"
}
},
"kind": {
"type": "string",
"description": "Type of resource.",
"default": "compute#forwardingRuleList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"ForwardingRulesScopedList": {
"id": "ForwardingRulesScopedList",
"type": "object",
"properties": {
"forwardingRules": {
"type": "array",
"description": "List of forwarding rules contained in this scope.",
"items": {
"$ref": "ForwardingRule"
}
},
"warning": {
"type": "object",
"description": "Informational warning which replaces the list of forwarding rules when the list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"HealthCheckReference": {
"id": "HealthCheckReference",
"type": "object",
"description": "A full or valid partial URL to a health check. For example, the following are valid URLs: \n- https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check \n- projects/project-id/global/httpHealthChecks/health-check \n- global/httpHealthChecks/health-check",
"properties": {
"healthCheck": {
"type": "string"
}
}
},
"HealthStatus": {
"id": "HealthStatus",
"type": "object",
"properties": {
"healthState": {
"type": "string",
"description": "Health state of the instance.",
"enum": [
"HEALTHY",
"UNHEALTHY"
],
"enumDescriptions": [
"",
""
]
},
"instance": {
"type": "string",
"description": "URL of the instance resource."
},
"ipAddress": {
"type": "string",
"description": "The IP address represented by this resource."
},
"port": {
"type": "integer",
"description": "The port on the instance.",
"format": "int32"
}
}
},
"HostRule": {
"id": "HostRule",
"type": "object",
"description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.",
"properties": {
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"hosts": {
"type": "array",
"description": "The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..",
"items": {
"type": "string"
}
},
"pathMatcher": {
"type": "string",
"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."
}
}
},
"HttpHealthCheck": {
"id": "HttpHealthCheck",
"type": "object",
"description": "An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.",
"properties": {
"checkIntervalSec": {
"type": "integer",
"description": "How often (in seconds) to send a health check. The default value is 5 seconds.",
"format": "int32"
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"healthyThreshold": {
"type": "integer",
"description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
"format": "int32"
},
"host": {
"type": "string",
"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."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.",
"default": "compute#httpHealthCheck"
},
"name": {
"type": "string",
"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])?"
},
"port": {
"type": "integer",
"description": "The TCP port number for the HTTP health check request. The default value is 80.",
"format": "int32"
},
"requestPath": {
"type": "string",
"description": "The request path of the HTTP health check request. The default value is /."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"timeoutSec": {
"type": "integer",
"description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.",
"format": "int32"
},
"unhealthyThreshold": {
"type": "integer",
"description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
"format": "int32"
}
}
},
"HttpHealthCheckList": {
"id": "HttpHealthCheckList",
"type": "object",
"description": "Contains a list of HttpHealthCheck resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] Unique identifier for the resource. Defined by the server."
},
"items": {
"type": "array",
"description": "A list of HttpHealthCheck resources.",
"items": {
"$ref": "HttpHealthCheck"
}
},
"kind": {
"type": "string",
"description": "Type of resource.",
"default": "compute#httpHealthCheckList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"HttpsHealthCheck": {
"id": "HttpsHealthCheck",
"type": "object",
"description": "An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.",
"properties": {
"checkIntervalSec": {
"type": "integer",
"description": "How often (in seconds) to send a health check. The default value is 5 seconds.",
"format": "int32"
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"healthyThreshold": {
"type": "integer",
"description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
"format": "int32"
},
"host": {
"type": "string",
"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."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "Type of the resource.",
"default": "compute#httpsHealthCheck"
},
"name": {
"type": "string",
"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])?"
},
"port": {
"type": "integer",
"description": "The TCP port number for the HTTPS health check request. The default value is 443.",
"format": "int32"
},
"requestPath": {
"type": "string",
"description": "The request path of the HTTPS health check request. The default value is \"/\"."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"timeoutSec": {
"type": "integer",
"description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.",
"format": "int32"
},
"unhealthyThreshold": {
"type": "integer",
"description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
"format": "int32"
}
}
},
"HttpsHealthCheckList": {
"id": "HttpsHealthCheckList",
"type": "object",
"description": "Contains a list of HttpsHealthCheck resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] Unique identifier for the resource; defined by the server."
},
"items": {
"type": "array",
"description": "A list of HttpsHealthCheck resources.",
"items": {
"$ref": "HttpsHealthCheck"
}
},
"kind": {
"type": "string",
"description": "Type of resource.",
"default": "compute#httpsHealthCheckList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"Image": {
"id": "Image",
"type": "object",
"description": "An Image resource.",
"properties": {
"archiveSizeBytes": {
"type": "string",
"description": "Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).",
"format": "int64"
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "The deprecation status associated with this image."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"diskSizeGb": {
"type": "string",
"description": "Size of the image when restored onto a persistent disk (in GB).",
"format": "int64"
},
"family": {
"type": "string",
"description": "The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#image for images.",
"default": "compute#image"
},
"licenses": {
"type": "array",
"description": "Any applicable publicly visible licenses.",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"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"
]
}
},
"rawDisk": {
"type": "object",
"description": "The parameters of the raw disk image.",
"properties": {
"containerType": {
"type": "string",
"description": "The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.",
"enum": [
"TAR"
],
"enumDescriptions": [
""
]
},
"sha1Checksum": {
"type": "string",
"description": "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}"
},
"source": {
"type": "string",
"description": "The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.",
"annotations": {
"required": [
"compute.images.insert"
]
}
}
}
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"sourceDisk": {
"type": "string",
"description": "URL of the The source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/disk/disk \n- projects/project/zones/zone/disk/disk \n- zones/zone/disks/disk"
},
"sourceDiskId": {
"type": "string",
"description": "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."
},
"sourceType": {
"type": "string",
"description": "The type of the image used to create this disk. The default and only value is RAW",
"default": "RAW",
"enum": [
"RAW"
],
"enumDescriptions": [
""
]
},
"status": {
"type": "string",
"description": "[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.",
"enum": [
"FAILED",
"PENDING",
"READY"
],
"enumDescriptions": [
"",
"",
""
]
}
}
},
"ImageList": {
"id": "ImageList",
"type": "object",
"description": "Contains a list of images.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of Image resources.",
"items": {
"$ref": "Image"
}
},
"kind": {
"type": "string",
"description": "Type of resource.",
"default": "compute#imageList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"Instance": {
"id": "Instance",
"type": "object",
"description": "An Instance resource.",
"properties": {
"canIpForward": {
"type": "boolean",
"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."
},
"cpuPlatform": {
"type": "string",
"description": "[Output Only] The CPU platform used by this instance."
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"disks": {
"type": "array",
"description": "Array of disks associated with this instance. Persistent disks must be created before you can assign them.",
"items": {
"$ref": "AttachedDisk"
}
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#instance for instances.",
"default": "compute#instance"
},
"machineType": {
"type": "string",
"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:\n\nzones/us-central1-f/machineTypes/n1-standard-1 \n\nTo create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):\n\nzones/zone/machineTypes/custom-CPUS-MEMORY \n\nFor example: zones/us-central1-f/machineTypes/custom-4-5120 \n\nFor a full list of restrictions, read the Specifications for custom machine types.",
"annotations": {
"required": [
"compute.instances.insert"
]
}
},
"metadata": {
"$ref": "Metadata",
"description": "The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys."
},
"name": {
"type": "string",
"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."
},
"networkInterfaces": {
"type": "array",
"description": "An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet.",
"items": {
"$ref": "NetworkInterface"
}
},
"scheduling": {
"$ref": "Scheduling",
"description": "Scheduling options for this instance."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
},
"serviceAccounts": {
"type": "array",
"description": "A list of service accounts, with their specified scopes, authorized for this instance. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Authenticating from Google Compute Engine for more information.",
"items": {
"$ref": "ServiceAccount"
}
},
"status": {
"type": "string",
"description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, and TERMINATED.",
"enum": [
"PROVISIONING",
"RUNNING",
"STAGING",
"STOPPED",
"STOPPING",
"SUSPENDED",
"SUSPENDING",
"TERMINATED"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
""
]
},
"statusMessage": {
"type": "string",
"description": "[Output Only] An optional, human-readable explanation of the status."
},
"tags": {
"$ref": "Tags",
"description": "A list of 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."
},
"zone": {
"type": "string",
"description": "[Output Only] URL of the zone where the instance resides."
}
}
},
"InstanceAggregatedList": {
"id": "InstanceAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "object",
"description": "[Output Only] A map of scoped instance lists.",
"additionalProperties": {
"$ref": "InstancesScopedList",
"description": "[Output Only] Name of the scope containing this set of instances."
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.",
"default": "compute#instanceAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"InstanceGroup": {
"id": "InstanceGroup",
"type": "object",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] The creation timestamp for this instance group in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"fingerprint": {
"type": "string",
"description": "[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.",
"format": "byte"
},
"id": {
"type": "string",
"description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] The resource type, which is always compute#instanceGroup for instance groups.",
"default": "compute#instanceGroup"
},
"name": {
"type": "string",
"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.instanceGroupManagers.insert"
]
}
},
"namedPorts": {
"type": "array",
"description": "Assigns a name to a port number. For example: {name: \"http\", port: 80}\n\nThis allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"http\", port: 80},{name: \"http\", port: 8080}] \n\nNamed ports apply to all instances in this instance group.",
"items": {
"$ref": "NamedPort"
}
},
"network": {
"type": "string",
"description": "The URL of the network to which all instances in the instance group belong."
},
"selfLink": {
"type": "string",
"description": "[Output Only] The URL for this instance group. The server generates this URL."
},
"size": {
"type": "integer",
"description": "[Output Only] The total number of instances in the instance group.",
"format": "int32"
},
"subnetwork": {
"type": "string",
"description": "The URL of the subnetwork to which all instances in the instance group belong."
},
"zone": {
"type": "string",
"description": "[Output Only] The URL of the zone where the instance group is located."
}
}
},
"InstanceGroupAggregatedList": {
"id": "InstanceGroupAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] A unique identifier for this aggregated list of instance groups. The server generates this identifier."
},
"items": {
"type": "object",
"description": "A map of scoped instance group lists.",
"additionalProperties": {
"$ref": "InstanceGroupsScopedList",
"description": "The name of the scope that contains this set of instance groups."
}
},
"kind": {
"type": "string",
"description": "[Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.",
"default": "compute#instanceGroupAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] The URL for this resource type. The server generates this URL."
}
}
},
"InstanceGroupList": {
"id": "InstanceGroupList",
"type": "object",
"description": "A list of InstanceGroup resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] A unique identifier for this list of instance groups. The server generates this identifier."
},
"items": {
"type": "array",
"description": "A list of instance groups.",
"items": {
"$ref": "InstanceGroup"
}
},
"kind": {
"type": "string",
"description": "[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.",
"default": "compute#instanceGroupList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] The URL for this resource type. The server generates this URL."
}
}
},
"InstanceGroupManager": {
"id": "InstanceGroupManager",
"type": "object",
"properties": {
"baseInstanceName": {
"type": "string",
"description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.",
"pattern": "[a-z][-a-z0-9]{0,57}",
"annotations": {
"required": [
"compute.instanceGroupManagers.insert"
]
}
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format."
},
"currentActions": {
"$ref": "InstanceGroupManagerActionsSummary",
"description": "[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"fingerprint": {
"type": "string",
"description": "[Output Only] The fingerprint of the resource data. You can use this optional field for optimistic locking when you update the resource.",
"format": "byte"
},
"id": {
"type": "string",
"description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.",
"format": "uint64"
},
"instanceGroup": {
"type": "string",
"description": "[Output Only] The URL of the Instance Group resource."
},
"instanceTemplate": {
"type": "string",
"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."
},
"kind": {
"type": "string",
"description": "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.",
"default": "compute#instanceGroupManager"
},
"name": {
"type": "string",
"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"
]
}
},
"namedPorts": {
"type": "array",
"description": "Named ports configured for the Instance Groups complementary to this Instance Group Manager.",
"items": {
"$ref": "NamedPort"
}
},
"selfLink": {
"type": "string",
"description": "[Output Only] The URL for this managed instance group. The server defines this URL."
},
"targetPools": {
"type": "array",
"description": "The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.",
"items": {
"type": "string"
}
},
"targetSize": {
"type": "integer",
"description": "The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.",
"format": "int32",
"annotations": {
"required": [
"compute.instanceGroupManagers.insert"
]
}
},
"zone": {
"type": "string",
"description": "The name of the zone where the managed instance group is located."
}
}
},
"InstanceGroupManagerActionsSummary": {
"id": "InstanceGroupManagerActionsSummary",
"type": "object",
"properties": {
"abandoning": {
"type": "integer",
"description": "[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.",
"format": "int32"
},
"creating": {
"type": "integer",
"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 one of these instances, it tries again until it creates the instance successfully.",
"format": "int32"
},
"deleting": {
"type": "integer",
"description": "[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.",
"format": "int32"
},
"none": {
"type": "integer",
"description": "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.",
"format": "int32"
},
"recreating": {
"type": "integer",
"description": "[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.",
"format": "int32"
},
"refreshing": {
"type": "integer",
"description": "[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.",
"format": "int32"
},
"restarting": {
"type": "integer",
"description": "[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.",
"format": "int32"
}
}
},
"InstanceGroupManagerAggregatedList": {
"id": "InstanceGroupManagerAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] A unique identifier for this aggregated list of managed instance groups. The server generates this identifier."
},
"items": {
"type": "object",
"description": "[Output Only] A map of filtered managed instance group lists.",
"additionalProperties": {
"$ref": "InstanceGroupManagersScopedList",
"description": "[Output Only] The name of the scope that contains this set of managed instance groups."
}
},
"kind": {
"type": "string",
"description": "[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.",
"default": "compute#instanceGroupManagerAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] The URL for this resource type. The server generates this URL."
}
}
},
"InstanceGroupManagerList": {
"id": "InstanceGroupManagerList",
"type": "object",
"description": "[Output Only] A list of managed instance groups.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] A unique identifier for this resource type. The server generates this identifier."
},
"items": {
"type": "array",
"description": "[Output Only] A list of managed instance groups.",
"items": {
"$ref": "InstanceGroupManager"
}
},
"kind": {
"type": "string",
"description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.",
"default": "compute#instanceGroupManagerList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] The URL for this resource type. The server generates this URL."
}
}
},
"InstanceGroupManagersAbandonInstancesRequest": {
"id": "InstanceGroupManagersAbandonInstancesRequest",
"type": "object",
"properties": {
"instances": {
"type": "array",
"description": "The URL for one or more instances to abandon from the managed instance group.",
"items": {
"type": "string"
}
}
}
},
"InstanceGroupManagersDeleteInstancesRequest": {
"id": "InstanceGroupManagersDeleteInstancesRequest",
"type": "object",
"properties": {
"instances": {
"type": "array",
"description": "The list of instances to delete from this managed instance group. Specify one or more instance URLs.",
"items": {
"type": "string"
}
}
}
},
"InstanceGroupManagersListManagedInstancesResponse": {
"id": "InstanceGroupManagersListManagedInstancesResponse",
"type": "object",
"properties": {
"managedInstances": {
"type": "array",
"description": "[Output Only] The list of instances in the managed instance group.",
"items": {
"$ref": "ManagedInstance"
}
}
}
},
"InstanceGroupManagersRecreateInstancesRequest": {
"id": "InstanceGroupManagersRecreateInstancesRequest",
"type": "object",
"properties": {
"instances": {
"type": "array",
"description": "The URL for one or more instances to recreate.",
"items": {
"type": "string"
}
}
}
},
"InstanceGroupManagersScopedList": {
"id": "InstanceGroupManagersScopedList",
"type": "object",
"properties": {
"instanceGroupManagers": {
"type": "array",
"description": "[Output Only] The list of managed instance groups that are contained in the specified project and zone.",
"items": {
"$ref": "InstanceGroupManager"
}
},
"warning": {
"type": "object",
"description": "[Output Only] The warning that replaces the list of managed instance groups when the list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"InstanceGroupManagersSetInstanceTemplateRequest": {
"id": "InstanceGroupManagersSetInstanceTemplateRequest",
"type": "object",
"properties": {
"instanceTemplate": {
"type": "string",
"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."
}
}
},
"InstanceGroupManagersSetTargetPoolsRequest": {
"id": "InstanceGroupManagersSetTargetPoolsRequest",
"type": "object",
"properties": {
"fingerprint": {
"type": "string",
"description": "The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.",
"format": "byte"
},
"targetPools": {
"type": "array",
"description": "The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.",
"items": {
"type": "string"
}
}
}
},
"InstanceGroupsAddInstancesRequest": {
"id": "InstanceGroupsAddInstancesRequest",
"type": "object",
"properties": {
"instances": {
"type": "array",
"description": "The list of instances to add to the instance group.",
"items": {
"$ref": "InstanceReference"
}
}
}
},
"InstanceGroupsListInstances": {
"id": "InstanceGroupsListInstances",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] A unique identifier for this list of instance groups. The server generates this identifier."
},
"items": {
"type": "array",
"description": "[Output Only] A list of instances and any named ports that are assigned to those instances.",
"items": {
"$ref": "InstanceWithNamedPorts"
}
},
"kind": {
"type": "string",
"description": "[Output Only] The resource type, which is always compute#instanceGroupsListInstances for lists of instance groups.",
"default": "compute#instanceGroupsListInstances"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] The URL for this list of instance groups. The server generates this URL."
}
}
},
"InstanceGroupsListInstancesRequest": {
"id": "InstanceGroupsListInstancesRequest",
"type": "object",
"properties": {
"instanceState": {
"type": "string",
"description": "A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.",
"enum": [
"ALL",
"RUNNING"
],
"enumDescriptions": [
"",
""
]
}
}
},
"InstanceGroupsRemoveInstancesRequest": {
"id": "InstanceGroupsRemoveInstancesRequest",
"type": "object",
"properties": {
"instances": {
"type": "array",
"description": "The list of instances to remove from the instance group.",
"items": {
"$ref": "InstanceReference"
}
}
}
},
"InstanceGroupsScopedList": {
"id": "InstanceGroupsScopedList",
"type": "object",
"properties": {
"instanceGroups": {
"type": "array",
"description": "[Output Only] The list of instance groups that are contained in this scope.",
"items": {
"$ref": "InstanceGroup"
}
},
"warning": {
"type": "object",
"description": "[Output Only] An informational warning that replaces the list of instance groups when the list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"InstanceGroupsSetNamedPortsRequest": {
"id": "InstanceGroupsSetNamedPortsRequest",
"type": "object",
"properties": {
"fingerprint": {
"type": "string",
"description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.",
"format": "byte"
},
"namedPorts": {
"type": "array",
"description": "The list of named ports to set for this instance group.",
"items": {
"$ref": "NamedPort"
}
}
}
},
"InstanceList": {
"id": "InstanceList",
"type": "object",
"description": "Contains a list of instances.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of instances.",
"items": {
"$ref": "Instance"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.",
"default": "compute#instanceList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"InstanceMoveRequest": {
"id": "InstanceMoveRequest",
"type": "object",
"properties": {
"destinationZone": {
"type": "string",
"description": "The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone \n- projects/project/zones/zone \n- zones/zone"
},
"targetInstance": {
"type": "string",
"description": "The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance \n- projects/project/zones/zone/instances/instance \n- zones/zone/instances/instance"
}
}
},
"InstanceProperties": {
"id": "InstanceProperties",
"type": "object",
"description": "",
"properties": {
"canIpForward": {
"type": "boolean",
"description": "Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the canIpForward documentation for more information."
},
"description": {
"type": "string",
"description": "An optional text description for the instances that are created from this instance template."
},
"disks": {
"type": "array",
"description": "An array of disks that are associated with the instances that are created from this template.",
"items": {
"$ref": "AttachedDisk"
}
},
"machineType": {
"type": "string",
"description": "The machine type to use for instances that are created from this template.",
"annotations": {
"required": [
"compute.instanceTemplates.insert"
]
}
},
"metadata": {
"$ref": "Metadata",
"description": "The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information."
},
"networkInterfaces": {
"type": "array",
"description": "An array of network access configurations for this interface.",
"items": {
"$ref": "NetworkInterface"
}
},
"scheduling": {
"$ref": "Scheduling",
"description": "Specifies the scheduling options for the instances that are created from this template."
},
"serviceAccounts": {
"type": "array",
"description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.",
"items": {
"$ref": "ServiceAccount"
}
},
"tags": {
"$ref": "Tags",
"description": "A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035."
}
}
},
"InstanceReference": {
"id": "InstanceReference",
"type": "object",
"properties": {
"instance": {
"type": "string",
"description": "The URL for a specific instance."
}
}
},
"InstanceTemplate": {
"id": "InstanceTemplate",
"type": "object",
"description": "An Instance Template resource.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] The creation timestamp for this instance template in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"id": {
"type": "string",
"description": "[Output Only] A unique identifier for this instance template. The server defines this identifier.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.",
"default": "compute#instanceTemplate"
},
"name": {
"type": "string",
"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"
]
}
},
"properties": {
"$ref": "InstanceProperties",
"description": "The instance properties for this instance template."
},
"selfLink": {
"type": "string",
"description": "[Output Only] The URL for this instance template. The server defines this URL."
}
}
},
"InstanceTemplateList": {
"id": "InstanceTemplateList",
"type": "object",
"description": "A list of instance templates.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] A unique identifier for this instance template. The server defines this identifier."
},
"items": {
"type": "array",
"description": "[Output Only] list of InstanceTemplate resources.",
"items": {
"$ref": "InstanceTemplate"
}
},
"kind": {
"type": "string",
"description": "[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.",
"default": "compute#instanceTemplateList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] The URL for this instance template list. The server defines this URL."
}
}
},
"InstanceWithNamedPorts": {
"id": "InstanceWithNamedPorts",
"type": "object",
"properties": {
"instance": {
"type": "string",
"description": "[Output Only] The URL of the instance."
},
"namedPorts": {
"type": "array",
"description": "[Output Only] The named ports that belong to this instance group.",
"items": {
"$ref": "NamedPort"
}
},
"status": {
"type": "string",
"description": "[Output Only] The status of the instance.",
"enum": [
"PROVISIONING",
"RUNNING",
"STAGING",
"STOPPED",
"STOPPING",
"SUSPENDED",
"SUSPENDING",
"TERMINATED"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
""
]
}
}
},
"InstancesScopedList": {
"id": "InstancesScopedList",
"type": "object",
"properties": {
"instances": {
"type": "array",
"description": "[Output Only] List of instances contained in this scope.",
"items": {
"$ref": "Instance"
}
},
"warning": {
"type": "object",
"description": "[Output Only] Informational warning which replaces the list of instances when the list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"InstancesSetMachineTypeRequest": {
"id": "InstancesSetMachineTypeRequest",
"type": "object",
"properties": {
"machineType": {
"type": "string",
"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"
}
}
},
"License": {
"id": "License",
"type": "object",
"description": "A license resource.",
"properties": {
"chargesUseFee": {
"type": "boolean",
"description": "[Output Only] If true, the customer will be charged license fee for running software that contains this license on an instance."
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#license for licenses.",
"default": "compute#license"
},
"name": {
"type": "string",
"description": "[Output Only] Name of the resource. The name is 1-63 characters long and complies with RFC1035.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"annotations": {
"required": [
"compute.images.insert"
]
}
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
}
}
},
"MachineType": {
"id": "MachineType",
"type": "object",
"description": "A Machine Type resource.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "[Output Only] The deprecation status associated with this machine type."
},
"description": {
"type": "string",
"description": "[Output Only] An optional textual description of the resource."
},
"guestCpus": {
"type": "integer",
"description": "[Output Only] The number of virtual CPUs that are available to the instance.",
"format": "int32"
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"imageSpaceGb": {
"type": "integer",
"description": "[Deprecated] This property is deprecated and will never be populated with any relevant values.",
"format": "int32"
},
"kind": {
"type": "string",
"description": "[Output Only] The type of the resource. Always compute#machineType for machine types.",
"default": "compute#machineType"
},
"maximumPersistentDisks": {
"type": "integer",
"description": "[Output Only] Maximum persistent disks allowed.",
"format": "int32"
},
"maximumPersistentDisksSizeGb": {
"type": "string",
"description": "[Output Only] Maximum total persistent disks size (GB) allowed.",
"format": "int64"
},
"memoryMb": {
"type": "integer",
"description": "[Output Only] The amount of physical memory available to the instance, defined in MB.",
"format": "int32"
},
"name": {
"type": "string",
"description": "[Output Only] Name of the resource.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?"
},
"scratchDisks": {
"type": "array",
"description": "[Output Only] List of extended scratch disks assigned to the instance.",
"items": {
"type": "object",
"properties": {
"diskGb": {
"type": "integer",
"description": "Size of the scratch disk, defined in GB.",
"format": "int32"
}
}
}
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"zone": {
"type": "string",
"description": "[Output Only] The name of the zone where the machine type resides, such as us-central1-a."
}
}
},
"MachineTypeAggregatedList": {
"id": "MachineTypeAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "object",
"description": "[Output Only] A map of scoped machine type lists.",
"additionalProperties": {
"$ref": "MachineTypesScopedList",
"description": "[Output Only] Name of the scope containing this set of machine types."
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.",
"default": "compute#machineTypeAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"MachineTypeList": {
"id": "MachineTypeList",
"type": "object",
"description": "Contains a list of machine types.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of Machine Type resources.",
"items": {
"$ref": "MachineType"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.",
"default": "compute#machineTypeList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"MachineTypesScopedList": {
"id": "MachineTypesScopedList",
"type": "object",
"properties": {
"machineTypes": {
"type": "array",
"description": "[Output Only] List of machine types contained in this scope.",
"items": {
"$ref": "MachineType"
}
},
"warning": {
"type": "object",
"description": "[Output Only] An informational warning that appears when the machine types list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"ManagedInstance": {
"id": "ManagedInstance",
"type": "object",
"properties": {
"currentAction": {
"type": "string",
"description": "[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: \n- NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. \n- CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. \n- CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's target_size value is decreased. \n- RECREATING The managed instance group is recreating this instance. \n- DELETING The managed instance group is permanently deleting this instance. \n- ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. \n- RESTARTING The managed instance group is restarting the instance. \n- REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance.",
"enum": [
"ABANDONING",
"CREATING",
"DELETING",
"NONE",
"RECREATING",
"REFRESHING",
"RESTARTING"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
]
},
"id": {
"type": "string",
"description": "[Output only] The unique identifier for this resource. This field is empty when instance does not exist.",
"format": "uint64"
},
"instance": {
"type": "string",
"description": "[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created."
},
"instanceStatus": {
"type": "string",
"description": "[Output Only] The status of the instance. This field is empty when the instance does not exist.",
"enum": [
"PROVISIONING",
"RUNNING",
"STAGING",
"STOPPED",
"STOPPING",
"SUSPENDED",
"SUSPENDING",
"TERMINATED"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
""
]
},
"lastAttempt": {
"$ref": "ManagedInstanceLastAttempt",
"description": "[Output Only] Information about the last attempt to create or delete the instance."
}
}
},
"ManagedInstanceLastAttempt": {
"id": "ManagedInstanceLastAttempt",
"type": "object",
"properties": {
"errors": {
"type": "object",
"description": "[Output Only] Encountered errors during the last attempt to create or delete the instance.",
"properties": {
"errors": {
"type": "array",
"description": "[Output Only] The array of errors encountered while processing this operation.",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] The error type identifier for this error."
},
"location": {
"type": "string",
"description": "[Output Only] Indicates the field in the request that caused the error. This property is optional."
},
"message": {
"type": "string",
"description": "[Output Only] An optional, human-readable error message."
}
}
}
}
}
}
}
},
"Metadata": {
"id": "Metadata",
"type": "object",
"description": "A metadata key/value entry.",
"properties": {
"fingerprint": {
"type": "string",
"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.",
"format": "byte"
},
"items": {
"type": "array",
"description": "Array of key/value pairs. The total size of all keys and values must be less than 512 KB.",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"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"
]
}
},
"value": {
"type": "string",
"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 32768 bytes.",
"annotations": {
"required": [
"compute.instances.insert",
"compute.projects.setCommonInstanceMetadata"
]
}
}
}
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#metadata for metadata.",
"default": "compute#metadata"
}
}
},
"NamedPort": {
"id": "NamedPort",
"type": "object",
"description": "The named port. For example: .",
"properties": {
"name": {
"type": "string",
"description": "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035."
},
"port": {
"type": "integer",
"description": "The port number, which can be a value between 1 and 65535.",
"format": "int32"
}
}
},
"Network": {
"id": "Network",
"type": "object",
"description": "Represents a Network resource. Read Networks and Firewalls for more information.",
"properties": {
"IPv4Range": {
"type": "string",
"description": "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}"
},
"autoCreateSubnetworks": {
"type": "boolean",
"description": "When set to true, the network is created in \"auto subnet mode\". When set to false, the network is in \"custom subnet mode\".\n\nIn \"auto subnet mode\", a newly created network is assigned the default CIDR of 10.128.0.0/9 and it automatically creates one subnetwork per region."
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"gatewayIPv4": {
"type": "string",
"description": "A gateway address for default routing to other networks. This value is read only and is selected by the Google Compute Engine, typically as the first usable address in the IPv4Range.",
"pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}"
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#network for networks.",
"default": "compute#network"
},
"name": {
"type": "string",
"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.networks.insert"
]
}
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"subnetworks": {
"type": "array",
"description": "[Output Only] Server-defined fully-qualified URLs for all subnetworks in this network.",
"items": {
"type": "string"
}
}
}
},
"NetworkInterface": {
"id": "NetworkInterface",
"type": "object",
"description": "A network interface resource attached to an instance.",
"properties": {
"accessConfigs": {
"type": "array",
"description": "An array of configurations for this interface. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.",
"items": {
"$ref": "AccessConfig"
}
},
"name": {
"type": "string",
"description": "[Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc."
},
"network": {
"type": "string",
"description": "URL of the network resource for this instance. This is required for creating an instance but optional when creating a firewall rule. If not specified when creating a firewall rule, the default network is used:\n\nglobal/networks/default \n\nIf you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project/global/networks/network \n- projects/project/global/networks/network \n- global/networks/default",
"annotations": {
"required": [
"compute.instances.insert"
]
}
},
"networkIP": {
"type": "string",
"description": "An IPv4 internal network 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."
},
"subnetwork": {
"type": "string",
"description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork \n- regions/region/subnetworks/subnetwork"
}
}
},
"NetworkList": {
"id": "NetworkList",
"type": "object",
"description": "Contains a list of networks.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of Network resources.",
"items": {
"$ref": "Network"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#networkList for lists of networks.",
"default": "compute#networkList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource ."
}
}
},
"Operation": {
"id": "Operation",
"type": "object",
"description": "An Operation resource, used to manage asynchronous API requests.",
"properties": {
"clientOperationId": {
"type": "string",
"description": "[Output Only] Reserved for future use."
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "[Output Only] A textual description of the operation, which is set when the operation is created."
},
"endTime": {
"type": "string",
"description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format."
},
"error": {
"type": "object",
"description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.",
"properties": {
"errors": {
"type": "array",
"description": "[Output Only] The array of errors encountered while processing this operation.",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] The error type identifier for this error."
},
"location": {
"type": "string",
"description": "[Output Only] Indicates the field in the request that caused the error. This property is optional."
},
"message": {
"type": "string",
"description": "[Output Only] An optional, human-readable error message."
}
}
}
}
}
},
"httpErrorMessage": {
"type": "string",
"description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND."
},
"httpErrorStatusCode": {
"type": "integer",
"description": "[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.",
"format": "int32"
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"insertTime": {
"type": "string",
"description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format."
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#operation for Operation resources.",
"default": "compute#operation"
},
"name": {
"type": "string",
"description": "[Output Only] Name of the resource."
},
"operationType": {
"type": "string",
"description": "[Output Only] The type of operation, such as insert, update, or delete, and so on."
},
"progress": {
"type": "integer",
"description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.",
"format": "int32"
},
"region": {
"type": "string",
"description": "[Output Only] The URL of the region where the operation resides. Only available when performing regional operations."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"startTime": {
"type": "string",
"description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format."
},
"status": {
"type": "string",
"description": "[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.",
"enum": [
"DONE",
"PENDING",
"RUNNING"
],
"enumDescriptions": [
"",
"",
""
]
},
"statusMessage": {
"type": "string",
"description": "[Output Only] An optional textual description of the current status of the operation."
},
"targetId": {
"type": "string",
"description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.",
"format": "uint64"
},
"targetLink": {
"type": "string",
"description": "[Output Only] The URL of the resource that the operation modifies."
},
"user": {
"type": "string",
"description": "[Output Only] User who requested the operation, for example: user@example.com."
},
"warnings": {
"type": "array",
"description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
},
"zone": {
"type": "string",
"description": "[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations."
}
}
},
"OperationAggregatedList": {
"id": "OperationAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "object",
"description": "[Output Only] A map of scoped operation lists.",
"additionalProperties": {
"$ref": "OperationsScopedList",
"description": "[Output Only] Name of the scope containing this set of operations."
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations.",
"default": "compute#operationAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"OperationList": {
"id": "OperationList",
"type": "object",
"description": "Contains a list of Operation resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of Operation resources.",
"items": {
"$ref": "Operation"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#operations for Operations resource.",
"default": "compute#operationList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"OperationsScopedList": {
"id": "OperationsScopedList",
"type": "object",
"properties": {
"operations": {
"type": "array",
"description": "[Output Only] List of operations contained in this scope.",
"items": {
"$ref": "Operation"
}
},
"warning": {
"type": "object",
"description": "[Output Only] Informational warning which replaces the list of operations when the list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"PathMatcher": {
"id": "PathMatcher",
"type": "object",
"description": "A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.",
"properties": {
"defaultService": {
"type": "string",
"description": "The full or partial URL to the BackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion. For example, the following are all valid URLs to a BackendService resource: \n- https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService \n- compute/v1/projects/project/global/backendServices/backendService \n- global/backendServices/backendService"
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"name": {
"type": "string",
"description": "The name to which this PathMatcher is referred by the HostRule."
},
"pathRules": {
"type": "array",
"description": "The list of path rules.",
"items": {
"$ref": "PathRule"
}
}
}
},
"PathRule": {
"id": "PathRule",
"type": "object",
"description": "A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.",
"properties": {
"paths": {
"type": "array",
"description": "The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.",
"items": {
"type": "string"
}
},
"service": {
"type": "string",
"description": "The URL of the BackendService resource if this rule is matched."
}
}
},
"Project": {
"id": "Project",
"type": "object",
"description": "A Project resource. Projects can only be created in the Google Cloud Platform Console. Unless marked otherwise, values can only be modified in the console.",
"properties": {
"commonInstanceMetadata": {
"$ref": "Metadata",
"description": "Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information."
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional textual description of the resource."
},
"enabledFeatures": {
"type": "array",
"description": "Restricted features enabled for use on this project.",
"items": {
"type": "string"
}
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#project for projects.",
"default": "compute#project"
},
"name": {
"type": "string",
"description": "The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine."
},
"quotas": {
"type": "array",
"description": "[Output Only] Quotas assigned to this project.",
"items": {
"$ref": "Quota"
}
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"usageExportLocation": {
"$ref": "UsageExportLocation",
"description": "The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored."
}
}
},
"Quota": {
"id": "Quota",
"type": "object",
"description": "A quotas entry.",
"properties": {
"limit": {
"type": "number",
"description": "[Output Only] Quota limit for this metric.",
"format": "double"
},
"metric": {
"type": "string",
"description": "[Output Only] Name of the quota metric.",
"enum": [
"AUTOSCALERS",
"BACKEND_SERVICES",
"CPUS",
"DISKS_TOTAL_GB",
"FIREWALLS",
"FORWARDING_RULES",
"HEALTH_CHECKS",
"IMAGES",
"INSTANCES",
"INSTANCE_GROUPS",
"INSTANCE_GROUP_MANAGERS",
"INSTANCE_TEMPLATES",
"IN_USE_ADDRESSES",
"LOCAL_SSD_TOTAL_GB",
"NETWORKS",
"ROUTES",
"SNAPSHOTS",
"SSD_TOTAL_GB",
"SSL_CERTIFICATES",
"STATIC_ADDRESSES",
"SUBNETWORKS",
"TARGET_HTTPS_PROXIES",
"TARGET_HTTP_PROXIES",
"TARGET_INSTANCES",
"TARGET_POOLS",
"TARGET_VPN_GATEWAYS",
"URL_MAPS",
"VPN_TUNNELS"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"usage": {
"type": "number",
"description": "[Output Only] Current usage of this metric.",
"format": "double"
}
}
},
"Region": {
"id": "Region",
"type": "object",
"description": "Region resource.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "[Output Only] The deprecation status associated with this region."
},
"description": {
"type": "string",
"description": "[Output Only] Textual description of the resource."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#region for regions.",
"default": "compute#region"
},
"name": {
"type": "string",
"description": "[Output Only] Name of the resource."
},
"quotas": {
"type": "array",
"description": "[Output Only] Quotas assigned to this region.",
"items": {
"$ref": "Quota"
}
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"status": {
"type": "string",
"description": "[Output Only] Status of the region, either UP or DOWN.",
"enum": [
"DOWN",
"UP"
],
"enumDescriptions": [
"",
""
]
},
"zones": {
"type": "array",
"description": "[Output Only] A list of zones available in this region, in the form of resource URLs.",
"items": {
"type": "string"
}
}
}
},
"RegionList": {
"id": "RegionList",
"type": "object",
"description": "Contains a list of region resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of Region resources.",
"items": {
"$ref": "Region"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#regionList for lists of regions.",
"default": "compute#regionList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"ResourceGroupReference": {
"id": "ResourceGroupReference",
"type": "object",
"properties": {
"group": {
"type": "string",
"description": "A URI referencing one of the resource views listed in the backend service."
}
}
},
"Route": {
"id": "Route",
"type": "object",
"description": "Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table.\n\nFor each packet leaving a instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, a instance gateway or a Google Compute Engine-operated gateway.\n\nPackets that do not match any route in the sending instance's routing table are dropped.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"destRange": {
"type": "string",
"description": "The destination range of outgoing packets that this route applies to.",
"annotations": {
"required": [
"compute.routes.insert"
]
}
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of this resource. Always compute#routes for Route resources.",
"default": "compute#route"
},
"name": {
"type": "string",
"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.routes.insert"
]
}
},
"network": {
"type": "string",
"description": "Fully-qualified URL of the network that this route applies to.",
"annotations": {
"required": [
"compute.routes.insert"
]
}
},
"nextHopGateway": {
"type": "string",
"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/\u003cproject-id\u003e/global/gateways/default-internet-gateway"
},
"nextHopInstance": {
"type": "string",
"description": "The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/"
},
"nextHopIp": {
"type": "string",
"description": "The network IP address of an instance that should handle matching packets."
},
"nextHopNetwork": {
"type": "string",
"description": "The URL of the local network if it should handle matching packets."
},
"nextHopVpnTunnel": {
"type": "string",
"description": "The URL to a VpnTunnel that should handle matching packets."
},
"priority": {
"type": "integer",
"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 the case of two routes with equal prefix length, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535.",
"format": "uint32",
"annotations": {
"required": [
"compute.routes.insert"
]
}
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined fully-qualified URL for this resource."
},
"tags": {
"type": "array",
"description": "A list of instance tags to which this route applies.",
"items": {
"type": "string"
},
"annotations": {
"required": [
"compute.routes.insert"
]
}
},
"warnings": {
"type": "array",
"description": "[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
}
},
"RouteList": {
"id": "RouteList",
"type": "object",
"description": "Contains a list of Route resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] Unique identifier for the resource. Defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of Route resources.",
"items": {
"$ref": "Route"
}
},
"kind": {
"type": "string",
"description": "Type of resource.",
"default": "compute#routeList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"Scheduling": {
"id": "Scheduling",
"type": "object",
"description": "Sets the scheduling options for an Instance.",
"properties": {
"automaticRestart": {
"type": "boolean",
"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."
},
"onHostMaintenance": {
"type": "string",
"description": "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.",
"enum": [
"MIGRATE",
"TERMINATE"
],
"enumDescriptions": [
"",
""
]
},
"preemptible": {
"type": "boolean",
"description": "Whether the instance is preemptible."
}
}
},
"SerialPortOutput": {
"id": "SerialPortOutput",
"type": "object",
"description": "An instance's serial console output.",
"properties": {
"contents": {
"type": "string",
"description": "[Output Only] The contents of the console output."
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.",
"default": "compute#serialPortOutput"
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
}
}
},
"ServiceAccount": {
"id": "ServiceAccount",
"type": "object",
"description": "A service account.",
"properties": {
"email": {
"type": "string",
"description": "Email address of the service account."
},
"scopes": {
"type": "array",
"description": "The list of scopes to be made available for this service account.",
"items": {
"type": "string"
}
}
}
},
"Snapshot": {
"id": "Snapshot",
"type": "object",
"description": "A persistent disk snapshot resource.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"diskSizeGb": {
"type": "string",
"description": "[Output Only] Size of the snapshot, specified in GB.",
"format": "int64"
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.",
"default": "compute#snapshot"
},
"licenses": {
"type": "array",
"description": "[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"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])?"
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"sourceDisk": {
"type": "string",
"description": "[Output Only] The source disk used to create this snapshot."
},
"sourceDiskId": {
"type": "string",
"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."
},
"status": {
"type": "string",
"description": "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.",
"enum": [
"CREATING",
"DELETING",
"FAILED",
"READY",
"UPLOADING"
],
"enumDescriptions": [
"",
"",
"",
"",
""
]
},
"storageBytes": {
"type": "string",
"description": "[Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.",
"format": "int64"
},
"storageBytesStatus": {
"type": "string",
"description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.",
"enum": [
"UPDATING",
"UP_TO_DATE"
],
"enumDescriptions": [
"",
""
]
}
}
},
"SnapshotList": {
"id": "SnapshotList",
"type": "object",
"description": "Contains a list of Snapshot resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of Snapshot resources.",
"items": {
"$ref": "Snapshot"
}
},
"kind": {
"type": "string",
"description": "Type of resource.",
"default": "compute#snapshotList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"SslCertificate": {
"id": "SslCertificate",
"type": "object",
"description": "An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.",
"properties": {
"certificate": {
"type": "string",
"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."
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.",
"default": "compute#sslCertificate"
},
"name": {
"type": "string",
"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])?"
},
"privateKey": {
"type": "string",
"description": "A write-only private key in PEM format. Only insert RPCs will include this field."
},
"selfLink": {
"type": "string",
"description": "[Output only] Server-defined URL for the resource."
}
}
},
"SslCertificateList": {
"id": "SslCertificateList",
"type": "object",
"description": "Contains a list of SslCertificate resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] Unique identifier for the resource. Defined by the server."
},
"items": {
"type": "array",
"description": "A list of SslCertificate resources.",
"items": {
"$ref": "SslCertificate"
}
},
"kind": {
"type": "string",
"description": "Type of resource.",
"default": "compute#sslCertificateList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"Subnetwork": {
"id": "Subnetwork",
"type": "object",
"description": "A Subnetwork resource.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"gatewayAddress": {
"type": "string",
"description": "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"ipCidrRange": {
"type": "string",
"description": "The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network."
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.",
"default": "compute#subnetwork"
},
"name": {
"type": "string",
"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])?"
},
"network": {
"type": "string",
"description": "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks."
},
"region": {
"type": "string",
"description": "URL of the region where the Subnetwork resides."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
}
}
},
"SubnetworkAggregatedList": {
"id": "SubnetworkAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "object",
"description": "[Output] A map of scoped Subnetwork lists.",
"additionalProperties": {
"$ref": "SubnetworksScopedList",
"description": "Name of the scope containing this set of Subnetworks."
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.",
"default": "compute#subnetworkAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"SubnetworkList": {
"id": "SubnetworkList",
"type": "object",
"description": "Contains a list of Subnetwork resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "The Subnetwork resources.",
"items": {
"$ref": "Subnetwork"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.",
"default": "compute#subnetworkList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"SubnetworksScopedList": {
"id": "SubnetworksScopedList",
"type": "object",
"properties": {
"subnetworks": {
"type": "array",
"description": "List of subnetworks contained in this scope.",
"items": {
"$ref": "Subnetwork"
}
},
"warning": {
"type": "object",
"description": "An informational warning that appears when the list of addresses is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"Tags": {
"id": "Tags",
"type": "object",
"description": "A set of instance tags.",
"properties": {
"fingerprint": {
"type": "string",
"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.\n\nTo see the latest fingerprint, make get() request to the instance.",
"format": "byte"
},
"items": {
"type": "array",
"description": "An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.",
"items": {
"type": "string"
}
}
}
},
"TargetHttpProxy": {
"id": "TargetHttpProxy",
"type": "object",
"description": "A TargetHttpProxy resource. This resource defines an HTTP proxy.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.",
"default": "compute#targetHttpProxy"
},
"name": {
"type": "string",
"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])?"
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"urlMap": {
"type": "string",
"description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService."
}
}
},
"TargetHttpProxyList": {
"id": "TargetHttpProxyList",
"type": "object",
"description": "A list of TargetHttpProxy resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "A list of TargetHttpProxy resources.",
"items": {
"$ref": "TargetHttpProxy"
}
},
"kind": {
"type": "string",
"description": "Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.",
"default": "compute#targetHttpProxyList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"TargetHttpsProxiesSetSslCertificatesRequest": {
"id": "TargetHttpsProxiesSetSslCertificatesRequest",
"type": "object",
"properties": {
"sslCertificates": {
"type": "array",
"description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.",
"items": {
"type": "string"
}
}
}
},
"TargetHttpsProxy": {
"id": "TargetHttpsProxy",
"type": "object",
"description": "A TargetHttpsProxy resource. This resource defines an HTTPS proxy.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.",
"default": "compute#targetHttpsProxy"
},
"name": {
"type": "string",
"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])?"
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"sslCertificates": {
"type": "array",
"description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. Currently, exactly one SSL certificate must be specified.",
"items": {
"type": "string"
}
},
"urlMap": {
"type": "string",
"description": "A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: \n- https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map \n- projects/project/global/urlMaps/url-map \n- global/urlMaps/url-map"
}
}
},
"TargetHttpsProxyList": {
"id": "TargetHttpsProxyList",
"type": "object",
"description": "Contains a list of TargetHttpsProxy resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "A list of TargetHttpsProxy resources.",
"items": {
"$ref": "TargetHttpsProxy"
}
},
"kind": {
"type": "string",
"description": "Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.",
"default": "compute#targetHttpsProxyList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"TargetInstance": {
"id": "TargetInstance",
"type": "object",
"description": "A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"instance": {
"type": "string",
"description": "A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance \n- projects/project/zones/zone/instances/instance \n- zones/zone/instances/instance"
},
"kind": {
"type": "string",
"description": "[Output Only] The type of the resource. Always compute#targetInstance for target instances.",
"default": "compute#targetInstance"
},
"name": {
"type": "string",
"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])?"
},
"natPolicy": {
"type": "string",
"description": "NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.",
"enum": [
"NO_NAT"
],
"enumDescriptions": [
""
]
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"zone": {
"type": "string",
"description": "[Output Only] URL of the zone where the target instance resides."
}
}
},
"TargetInstanceAggregatedList": {
"id": "TargetInstanceAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] Unique identifier for the resource; defined by the server."
},
"items": {
"type": "object",
"description": "A map of scoped target instance lists.",
"additionalProperties": {
"$ref": "TargetInstancesScopedList",
"description": "Name of the scope containing this set of target instances."
}
},
"kind": {
"type": "string",
"description": "Type of resource.",
"default": "compute#targetInstanceAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"TargetInstanceList": {
"id": "TargetInstanceList",
"type": "object",
"description": "Contains a list of TargetInstance resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "A list of TargetInstance resources.",
"items": {
"$ref": "TargetInstance"
}
},
"kind": {
"type": "string",
"description": "Type of resource.",
"default": "compute#targetInstanceList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"TargetInstancesScopedList": {
"id": "TargetInstancesScopedList",
"type": "object",
"properties": {
"targetInstances": {
"type": "array",
"description": "List of target instances contained in this scope.",
"items": {
"$ref": "TargetInstance"
}
},
"warning": {
"type": "object",
"description": "Informational warning which replaces the list of addresses when the list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"TargetPool": {
"id": "TargetPool",
"type": "object",
"description": "A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.",
"properties": {
"backupPool": {
"type": "string",
"description": "This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].\n\nbackupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.\n\nIn case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy."
},
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"failoverRatio": {
"type": "number",
"description": "This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].\n\nIf set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.\n\nIn case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.",
"format": "float"
},
"healthChecks": {
"type": "array",
"description": "A list of URLs to the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if all specified health checks pass. An empty list means all member instances will be considered healthy at all times.",
"items": {
"type": "string"
}
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"instances": {
"type": "array",
"description": "A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.",
"items": {
"type": "string"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#targetPool for target pools.",
"default": "compute#targetPool"
},
"name": {
"type": "string",
"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])?"
},
"region": {
"type": "string",
"description": "[Output Only] URL of the region where the target pool resides."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"sessionAffinity": {
"type": "string",
"description": "Sesssion affinity option, must be one of the following values:\nNONE: Connections from the same client IP may go to any instance in the pool.\nCLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.\nCLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.",
"enum": [
"CLIENT_IP",
"CLIENT_IP_PROTO",
"NONE"
],
"enumDescriptions": [
"",
"",
""
]
}
}
},
"TargetPoolAggregatedList": {
"id": "TargetPoolAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] Unique identifier for the resource. Defined by the server."
},
"items": {
"type": "object",
"description": "[Output Only] A map of scoped target pool lists.",
"additionalProperties": {
"$ref": "TargetPoolsScopedList",
"description": "Name of the scope containing this set of target pools."
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.",
"default": "compute#targetPoolAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"TargetPoolInstanceHealth": {
"id": "TargetPoolInstanceHealth",
"type": "object",
"properties": {
"healthStatus": {
"type": "array",
"items": {
"$ref": "HealthStatus"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.",
"default": "compute#targetPoolInstanceHealth"
}
}
},
"TargetPoolList": {
"id": "TargetPoolList",
"type": "object",
"description": "Contains a list of TargetPool resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] Unique identifier for the resource. Defined by the server."
},
"items": {
"type": "array",
"description": "A list of TargetPool resources.",
"items": {
"$ref": "TargetPool"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.",
"default": "compute#targetPoolList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"TargetPoolsAddHealthCheckRequest": {
"id": "TargetPoolsAddHealthCheckRequest",
"type": "object",
"properties": {
"healthChecks": {
"type": "array",
"description": "A list of HttpHealthCheck resources to add to the target pool.",
"items": {
"$ref": "HealthCheckReference"
}
}
}
},
"TargetPoolsAddInstanceRequest": {
"id": "TargetPoolsAddInstanceRequest",
"type": "object",
"properties": {
"instances": {
"type": "array",
"description": "A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name \n- projects/project-id/zones/zone/instances/instance-name \n- zones/zone/instances/instance-name",
"items": {
"$ref": "InstanceReference"
}
}
}
},
"TargetPoolsRemoveHealthCheckRequest": {
"id": "TargetPoolsRemoveHealthCheckRequest",
"type": "object",
"properties": {
"healthChecks": {
"type": "array",
"description": "Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: \n- https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check \n- projects/project/global/httpHealthChecks/health-check \n- global/httpHealthChecks/health-check",
"items": {
"$ref": "HealthCheckReference"
}
}
}
},
"TargetPoolsRemoveInstanceRequest": {
"id": "TargetPoolsRemoveInstanceRequest",
"type": "object",
"properties": {
"instances": {
"type": "array",
"description": "URLs of the instances to be removed from target pool.",
"items": {
"$ref": "InstanceReference"
}
}
}
},
"TargetPoolsScopedList": {
"id": "TargetPoolsScopedList",
"type": "object",
"properties": {
"targetPools": {
"type": "array",
"description": "List of target pools contained in this scope.",
"items": {
"$ref": "TargetPool"
}
},
"warning": {
"type": "object",
"description": "Informational warning which replaces the list of addresses when the list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"TargetReference": {
"id": "TargetReference",
"type": "object",
"properties": {
"target": {
"type": "string"
}
}
},
"TargetVpnGateway": {
"id": "TargetVpnGateway",
"type": "object",
"description": "Represents a Target VPN gateway resource.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"forwardingRules": {
"type": "array",
"description": "[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated to a VPN gateway.",
"items": {
"type": "string"
}
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
"default": "compute#targetVpnGateway"
},
"name": {
"type": "string",
"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"
]
}
},
"network": {
"type": "string",
"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"
]
}
},
"region": {
"type": "string",
"description": "[Output Only] URL of the region where the target VPN gateway resides."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"status": {
"type": "string",
"description": "[Output Only] The status of the VPN gateway.",
"enum": [
"CREATING",
"DELETING",
"FAILED",
"READY"
],
"enumDescriptions": [
"",
"",
"",
""
]
},
"tunnels": {
"type": "array",
"description": "[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using compute.vpntunnels.insert method and associated to a VPN gateway.",
"items": {
"type": "string"
}
}
}
},
"TargetVpnGatewayAggregatedList": {
"id": "TargetVpnGatewayAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "object",
"description": "A map of scoped target vpn gateway lists.",
"additionalProperties": {
"$ref": "TargetVpnGatewaysScopedList",
"description": "[Output Only] Name of the scope containing this set of target VPN gateways."
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
"default": "compute#targetVpnGatewayAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
}
}
},
"TargetVpnGatewayList": {
"id": "TargetVpnGatewayList",
"type": "object",
"description": "Contains a list of TargetVpnGateway resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of TargetVpnGateway resources.",
"items": {
"$ref": "TargetVpnGateway"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
"default": "compute#targetVpnGatewayList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
}
}
},
"TargetVpnGatewaysScopedList": {
"id": "TargetVpnGatewaysScopedList",
"type": "object",
"properties": {
"targetVpnGateways": {
"type": "array",
"description": "[Output Only] List of target vpn gateways contained in this scope.",
"items": {
"$ref": "TargetVpnGateway"
}
},
"warning": {
"type": "object",
"description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"TestFailure": {
"id": "TestFailure",
"type": "object",
"properties": {
"actualService": {
"type": "string"
},
"expectedService": {
"type": "string"
},
"host": {
"type": "string"
},
"path": {
"type": "string"
}
}
},
"UrlMap": {
"id": "UrlMap",
"type": "object",
"description": "A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the \"longest-match\" of the URL's host and path.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"defaultService": {
"type": "string",
"description": "The URL of the BackendService resource if none of the hostRules match."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"fingerprint": {
"type": "string",
"description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap.",
"format": "byte"
},
"hostRules": {
"type": "array",
"description": "The list of HostRules to use against the URL.",
"items": {
"$ref": "HostRule"
}
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#urlMaps for url maps.",
"default": "compute#urlMap"
},
"name": {
"type": "string",
"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])?"
},
"pathMatchers": {
"type": "array",
"description": "The list of named PathMatchers to use against the URL.",
"items": {
"$ref": "PathMatcher"
}
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"tests": {
"type": "array",
"description": "The list of expected URL mappings. Request to update this UrlMap will succeed only if all of the test cases pass.",
"items": {
"$ref": "UrlMapTest"
}
}
}
},
"UrlMapList": {
"id": "UrlMapList",
"type": "object",
"description": "Contains a list of UrlMap resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] Unique identifier for the resource. Set by the server."
},
"items": {
"type": "array",
"description": "A list of UrlMap resources.",
"items": {
"$ref": "UrlMap"
}
},
"kind": {
"type": "string",
"description": "Type of resource.",
"default": "compute#urlMapList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"UrlMapReference": {
"id": "UrlMapReference",
"type": "object",
"properties": {
"urlMap": {
"type": "string"
}
}
},
"UrlMapTest": {
"id": "UrlMapTest",
"type": "object",
"description": "Message for the expected URL mappings.",
"properties": {
"description": {
"type": "string",
"description": "Description of this test case."
},
"host": {
"type": "string",
"description": "Host portion of the URL."
},
"path": {
"type": "string",
"description": "Path portion of the URL."
},
"service": {
"type": "string",
"description": "Expected BackendService resource the given URL should be mapped to."
}
}
},
"UrlMapValidationResult": {
"id": "UrlMapValidationResult",
"type": "object",
"description": "Message representing the validation result for a UrlMap.",
"properties": {
"loadErrors": {
"type": "array",
"items": {
"type": "string"
}
},
"loadSucceeded": {
"type": "boolean",
"description": "Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons."
},
"testFailures": {
"type": "array",
"items": {
"$ref": "TestFailure"
}
},
"testPassed": {
"type": "boolean",
"description": "If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure."
}
}
},
"UrlMapsValidateRequest": {
"id": "UrlMapsValidateRequest",
"type": "object",
"properties": {
"resource": {
"$ref": "UrlMap",
"description": "Content of the UrlMap to be validated."
}
}
},
"UrlMapsValidateResponse": {
"id": "UrlMapsValidateResponse",
"type": "object",
"properties": {
"result": {
"$ref": "UrlMapValidationResult"
}
}
},
"UsageExportLocation": {
"id": "UsageExportLocation",
"type": "object",
"description": "The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.",
"properties": {
"bucketName": {
"type": "string",
"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."
},
"reportNamePrefix": {
"type": "string",
"description": "An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions."
}
}
},
"VpnTunnel": {
"id": "VpnTunnel",
"type": "object",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"description": {
"type": "string",
"description": "An optional description of this resource. Provide this property when you create the resource."
},
"detailedStatus": {
"type": "string",
"description": "[Output Only] Detailed status message for the VPN tunnel."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"ikeVersion": {
"type": "integer",
"description": "IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.",
"format": "int32"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
"default": "compute#vpnTunnel"
},
"localTrafficSelector": {
"type": "array",
"description": "Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint.",
"items": {
"type": "string"
}
},
"name": {
"type": "string",
"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"
]
}
},
"peerIp": {
"type": "string",
"description": "IP address of the peer VPN gateway."
},
"region": {
"type": "string",
"description": "[Output Only] URL of the region where the VPN tunnel resides."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"sharedSecret": {
"type": "string",
"description": "Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway."
},
"sharedSecretHash": {
"type": "string",
"description": "Hash of the shared secret."
},
"status": {
"type": "string",
"description": "[Output Only] The status of the VPN tunnel.",
"enum": [
"ALLOCATING_RESOURCES",
"AUTHORIZATION_ERROR",
"DEPROVISIONING",
"ESTABLISHED",
"FAILED",
"FIRST_HANDSHAKE",
"NEGOTIATION_FAILURE",
"NETWORK_ERROR",
"NO_INCOMING_PACKETS",
"PROVISIONING",
"REJECTED",
"WAITING_FOR_FULL_CONFIG"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"targetVpnGateway": {
"type": "string",
"description": "URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.",
"annotations": {
"required": [
"compute.vpnTunnels.insert"
]
}
}
}
},
"VpnTunnelAggregatedList": {
"id": "VpnTunnelAggregatedList",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "object",
"description": "[Output Only] A map of scoped vpn tunnel lists.",
"additionalProperties": {
"$ref": "VpnTunnelsScopedList",
"description": "Name of the scope containing this set of vpn tunnels."
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
"default": "compute#vpnTunnelAggregatedList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
},
"VpnTunnelList": {
"id": "VpnTunnelList",
"type": "object",
"description": "Contains a list of VpnTunnel resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of VpnTunnel resources.",
"items": {
"$ref": "VpnTunnel"
}
},
"kind": {
"type": "string",
"description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
"default": "compute#vpnTunnelList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
}
}
},
"VpnTunnelsScopedList": {
"id": "VpnTunnelsScopedList",
"type": "object",
"properties": {
"vpnTunnels": {
"type": "array",
"description": "List of vpn tunnels contained in this scope.",
"items": {
"$ref": "VpnTunnel"
}
},
"warning": {
"type": "object",
"description": "Informational warning which replaces the list of addresses when the list is empty.",
"properties": {
"code": {
"type": "string",
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"INJECTED_KERNELS_DEPRECATED",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_NOT_DELETED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"data": {
"type": "array",
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)."
},
"value": {
"type": "string",
"description": "[Output Only] A warning data value corresponding to the key."
}
}
}
},
"message": {
"type": "string",
"description": "[Output Only] A human-readable description of the warning code."
}
}
}
}
},
"Zone": {
"id": "Zone",
"type": "object",
"description": "A Zone resource.",
"properties": {
"creationTimestamp": {
"type": "string",
"description": "[Output Only] Creation timestamp in RFC3339 text format."
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "[Output Only] The deprecation status associated with this zone."
},
"description": {
"type": "string",
"description": "[Output Only] Textual description of the resource."
},
"id": {
"type": "string",
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64"
},
"kind": {
"type": "string",
"description": "[Output Only] Type of the resource. Always compute#zone for zones.",
"default": "compute#zone"
},
"name": {
"type": "string",
"description": "[Output Only] Name of the resource."
},
"region": {
"type": "string",
"description": "[Output Only] Full URL reference to the region which hosts the zone."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for the resource."
},
"status": {
"type": "string",
"description": "[Output Only] Status of the zone, either UP or DOWN.",
"enum": [
"DOWN",
"UP"
],
"enumDescriptions": [
"",
""
]
}
}
},
"ZoneList": {
"id": "ZoneList",
"type": "object",
"description": "Contains a list of zone resources.",
"properties": {
"id": {
"type": "string",
"description": "[Output Only] Unique identifier for the resource; defined by the server."
},
"items": {
"type": "array",
"description": "[Output Only] A list of Zone resources.",
"items": {
"$ref": "Zone"
}
},
"kind": {
"type": "string",
"description": "Type of resource.",
"default": "compute#zoneList"
},
"nextPageToken": {
"type": "string",
"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."
},
"selfLink": {
"type": "string",
"description": "[Output Only] Server-defined URL for this resource."
}
}
}
},
"resources": {
"addresses": {
"methods": {
"aggregatedList": {
"id": "compute.addresses.aggregatedList",
"path": "{project}/aggregated/addresses",
"httpMethod": "GET",
"description": "Retrieves an aggregated list of addresses.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"delete": {
"id": "compute.addresses.delete",
"path": "{project}/regions/{region}/addresses/{address}",
"httpMethod": "DELETE",
"description": "Deletes the specified address resource.",
"parameters": {
"address": {
"type": "string",
"description": "Name of the address resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region",
"address"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.addresses.get",
"path": "{project}/regions/{region}/addresses/{address}",
"httpMethod": "GET",
"description": "Returns the specified address resource.",
"parameters": {
"address": {
"type": "string",
"description": "Name of the address resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.addresses.insert",
"path": "{project}/regions/{region}/addresses",
"httpMethod": "POST",
"description": "Creates an address resource in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region"
],
"request": {
"$ref": "Address"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.addresses.list",
"path": "{project}/regions/{region}/addresses",
"httpMethod": "GET",
"description": "Retrieves a list of addresses contained within the specified region.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
}
}
},
"autoscalers": {
"methods": {
"aggregatedList": {
"id": "compute.autoscalers.aggregatedList",
"path": "{project}/aggregated/autoscalers",
"httpMethod": "GET",
"description": "Retrieves an aggregated list of autoscalers.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"delete": {
"id": "compute.autoscalers.delete",
"path": "{project}/zones/{zone}/autoscalers/{autoscaler}",
"httpMethod": "DELETE",
"description": "Deletes the specified autoscaler.",
"parameters": {
"autoscaler": {
"type": "string",
"description": "Name of the autoscaler to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"autoscaler"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.autoscalers.get",
"path": "{project}/zones/{zone}/autoscalers/{autoscaler}",
"httpMethod": "GET",
"description": "Returns the specified autoscaler resource. Get a list of available autoscalers by making a list() request.",
"parameters": {
"autoscaler": {
"type": "string",
"description": "Name of the autoscaler to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.autoscalers.insert",
"path": "{project}/zones/{zone}/autoscalers",
"httpMethod": "POST",
"description": "Creates an autoscaler in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone"
],
"request": {
"$ref": "Autoscaler"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.autoscalers.list",
"path": "{project}/zones/{zone}/autoscalers",
"httpMethod": "GET",
"description": "Retrieves a list of autoscalers contained within the specified zone.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"patch": {
"id": "compute.autoscalers.patch",
"path": "{project}/zones/{zone}/autoscalers",
"httpMethod": "PATCH",
"description": "Updates an autoscaler in the specified project using the data included in the request. This method supports patch semantics.",
"parameters": {
"autoscaler": {
"type": "string",
"description": "Name of the autoscaler to update.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"autoscaler"
],
"request": {
"$ref": "Autoscaler"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"id": "compute.autoscalers.update",
"path": "{project}/zones/{zone}/autoscalers",
"httpMethod": "PUT",
"description": "Updates an autoscaler in the specified project using the data included in the request.",
"parameters": {
"autoscaler": {
"type": "string",
"description": "Name of the autoscaler to update.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone"
],
"request": {
"$ref": "Autoscaler"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"backendServices": {
"methods": {
"delete": {
"id": "compute.backendServices.delete",
"path": "{project}/global/backendServices/{backendService}",
"httpMethod": "DELETE",
"description": "Deletes the specified BackendService resource.",
"parameters": {
"backendService": {
"type": "string",
"description": "Name of the BackendService resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"backendService"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.backendServices.get",
"path": "{project}/global/backendServices/{backendService}",
"httpMethod": "GET",
"description": "Returns the specified BackendService resource. Get a list of available backend services by making a list() request.",
"parameters": {
"backendService": {
"type": "string",
"description": "Name of the BackendService resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"getHealth": {
"id": "compute.backendServices.getHealth",
"path": "{project}/global/backendServices/{backendService}/getHealth",
"httpMethod": "POST",
"description": "Gets the most recent health check results for this BackendService.",
"parameters": {
"backendService": {
"type": "string",
"description": "Name of the BackendService resource to which the queried instance belongs.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.backendServices.insert",
"path": "{project}/global/backendServices",
"httpMethod": "POST",
"description": "Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Restrictions and Guidelines for more information.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "BackendService"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.backendServices.list",
"path": "{project}/global/backendServices",
"httpMethod": "GET",
"description": "Retrieves the list of BackendService resources available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"patch": {
"id": "compute.backendServices.patch",
"path": "{project}/global/backendServices/{backendService}",
"httpMethod": "PATCH",
"description": "Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information. This method supports patch semantics.",
"parameters": {
"backendService": {
"type": "string",
"description": "Name of the BackendService resource to update.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"backendService"
],
"request": {
"$ref": "BackendService"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"id": "compute.backendServices.update",
"path": "{project}/global/backendServices/{backendService}",
"httpMethod": "PUT",
"description": "Updates the entire content of the BackendService resource. There are several restrictions and guidelines to keep in mind when updating a backend service. Read Restrictions and Guidelines for more information.",
"parameters": {
"backendService": {
"type": "string",
"description": "Name of the BackendService resource to update.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"backendService"
],
"request": {
"$ref": "BackendService"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"diskTypes": {
"methods": {
"aggregatedList": {
"id": "compute.diskTypes.aggregatedList",
"path": "{project}/aggregated/diskTypes",
"httpMethod": "GET",
"description": "Retrieves an aggregated list of disk types.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"get": {
"id": "compute.diskTypes.get",
"path": "{project}/zones/{zone}/diskTypes/{diskType}",
"httpMethod": "GET",
"description": "Returns the specified disk type. Get a list of available disk types by making a list() request.",
"parameters": {
"diskType": {
"type": "string",
"description": "Name of the disk type to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"list": {
"id": "compute.diskTypes.list",
"path": "{project}/zones/{zone}/diskTypes",
"httpMethod": "GET",
"description": "Retrieves a list of disk types available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
}
}
},
"disks": {
"methods": {
"aggregatedList": {
"id": "compute.disks.aggregatedList",
"path": "{project}/aggregated/disks",
"httpMethod": "GET",
"description": "Retrieves an aggregated list of persistent disks.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"createSnapshot": {
"id": "compute.disks.createSnapshot",
"path": "{project}/zones/{zone}/disks/{disk}/createSnapshot",
"httpMethod": "POST",
"description": "Creates a snapshot of a specified persistent disk.",
"parameters": {
"disk": {
"type": "string",
"description": "Name of the persistent disk to snapshot.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"disk"
],
"request": {
"$ref": "Snapshot"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"id": "compute.disks.delete",
"path": "{project}/zones/{zone}/disks/{disk}",
"httpMethod": "DELETE",
"description": "Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.",
"parameters": {
"disk": {
"type": "string",
"description": "Name of the persistent disk to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"disk"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.disks.get",
"path": "{project}/zones/{zone}/disks/{disk}",
"httpMethod": "GET",
"description": "Returns a specified persistent disk. Get a list of available persistent disks by making a list() request.",
"parameters": {
"disk": {
"type": "string",
"description": "Name of the persistent disk to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.disks.insert",
"path": "{project}/zones/{zone}/disks",
"httpMethod": "POST",
"description": "Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"sourceImage": {
"type": "string",
"description": "Optional. Source image to restore onto a disk.",
"location": "query"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone"
],
"request": {
"$ref": "Disk"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.disks.list",
"path": "{project}/zones/{zone}/disks",
"httpMethod": "GET",
"description": "Retrieves a list of persistent disks contained within the specified zone.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"resize": {
"id": "compute.disks.resize",
"path": "{project}/zones/{zone}/disks/{disk}/resize",
"httpMethod": "POST",
"description": "Resizes the specified persistent disk.",
"parameters": {
"disk": {
"type": "string",
"description": "The name of the persistent disk.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"disk"
],
"request": {
"$ref": "DisksResizeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"firewalls": {
"methods": {
"delete": {
"id": "compute.firewalls.delete",
"path": "{project}/global/firewalls/{firewall}",
"httpMethod": "DELETE",
"description": "Deletes the specified firewall.",
"parameters": {
"firewall": {
"type": "string",
"description": "Name of the firewall rule to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"firewall"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.firewalls.get",
"path": "{project}/global/firewalls/{firewall}",
"httpMethod": "GET",
"description": "Returns the specified firewall.",
"parameters": {
"firewall": {
"type": "string",
"description": "Name of the firewall rule to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.firewalls.insert",
"path": "{project}/global/firewalls",
"httpMethod": "POST",
"description": "Creates a firewall rule in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "Firewall"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.firewalls.list",
"path": "{project}/global/firewalls",
"httpMethod": "GET",
"description": "Retrieves the list of firewall rules available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"patch": {
"id": "compute.firewalls.patch",
"path": "{project}/global/firewalls/{firewall}",
"httpMethod": "PATCH",
"description": "Updates the specified firewall rule with the data included in the request. This method supports patch semantics.",
"parameters": {
"firewall": {
"type": "string",
"description": "Name of the firewall rule to update.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"firewall"
],
"request": {
"$ref": "Firewall"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"id": "compute.firewalls.update",
"path": "{project}/global/firewalls/{firewall}",
"httpMethod": "PUT",
"description": "Updates the specified firewall rule with the data included in the request.",
"parameters": {
"firewall": {
"type": "string",
"description": "Name of the firewall rule to update.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"firewall"
],
"request": {
"$ref": "Firewall"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"forwardingRules": {
"methods": {
"aggregatedList": {
"id": "compute.forwardingRules.aggregatedList",
"path": "{project}/aggregated/forwardingRules",
"httpMethod": "GET",
"description": "Retrieves an aggregated list of forwarding rules.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"delete": {
"id": "compute.forwardingRules.delete",
"path": "{project}/regions/{region}/forwardingRules/{forwardingRule}",
"httpMethod": "DELETE",
"description": "Deletes the specified ForwardingRule resource.",
"parameters": {
"forwardingRule": {
"type": "string",
"description": "Name of the ForwardingRule resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region",
"forwardingRule"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.forwardingRules.get",
"path": "{project}/regions/{region}/forwardingRules/{forwardingRule}",
"httpMethod": "GET",
"description": "Returns the specified ForwardingRule resource.",
"parameters": {
"forwardingRule": {
"type": "string",
"description": "Name of the ForwardingRule resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.forwardingRules.insert",
"path": "{project}/regions/{region}/forwardingRules",
"httpMethod": "POST",
"description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region"
],
"request": {
"$ref": "ForwardingRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.forwardingRules.list",
"path": "{project}/regions/{region}/forwardingRules",
"httpMethod": "GET",
"description": "Retrieves a list of ForwardingRule resources available to the specified project and region.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"setTarget": {
"id": "compute.forwardingRules.setTarget",
"path": "{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget",
"httpMethod": "POST",
"description": "Changes target URL for forwarding rule. The new target should be of the same type as the old target.",
"parameters": {
"forwardingRule": {
"type": "string",
"description": "Name of the ForwardingRule resource in which target is to be set.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region",
"forwardingRule"
],
"request": {
"$ref": "TargetReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"globalAddresses": {
"methods": {
"delete": {
"id": "compute.globalAddresses.delete",
"path": "{project}/global/addresses/{address}",
"httpMethod": "DELETE",
"description": "Deletes the specified address resource.",
"parameters": {
"address": {
"type": "string",
"description": "Name of the address resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"address"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.globalAddresses.get",
"path": "{project}/global/addresses/{address}",
"httpMethod": "GET",
"description": "Returns the specified address resource. Get a list of available addresses by making a list() request.",
"parameters": {
"address": {
"type": "string",
"description": "Name of the address resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.globalAddresses.insert",
"path": "{project}/global/addresses",
"httpMethod": "POST",
"description": "Creates an address resource in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "Address"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.globalAddresses.list",
"path": "{project}/global/addresses",
"httpMethod": "GET",
"description": "Retrieves a list of global addresses.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
}
}
},
"globalForwardingRules": {
"methods": {
"delete": {
"id": "compute.globalForwardingRules.delete",
"path": "{project}/global/forwardingRules/{forwardingRule}",
"httpMethod": "DELETE",
"description": "Deletes the specified ForwardingRule resource.",
"parameters": {
"forwardingRule": {
"type": "string",
"description": "Name of the ForwardingRule resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"forwardingRule"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.globalForwardingRules.get",
"path": "{project}/global/forwardingRules/{forwardingRule}",
"httpMethod": "GET",
"description": "Returns the specified ForwardingRule resource. Get a list of available forwarding rules by making a list() request.",
"parameters": {
"forwardingRule": {
"type": "string",
"description": "Name of the ForwardingRule resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.globalForwardingRules.insert",
"path": "{project}/global/forwardingRules",
"httpMethod": "POST",
"description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "ForwardingRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.globalForwardingRules.list",
"path": "{project}/global/forwardingRules",
"httpMethod": "GET",
"description": "Retrieves a list of ForwardingRule resources available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"setTarget": {
"id": "compute.globalForwardingRules.setTarget",
"path": "{project}/global/forwardingRules/{forwardingRule}/setTarget",
"httpMethod": "POST",
"description": "Changes target URL for forwarding rule. The new target should be of the same type as the old target.",
"parameters": {
"forwardingRule": {
"type": "string",
"description": "Name of the ForwardingRule resource in which target is to be set.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"forwardingRule"
],
"request": {
"$ref": "TargetReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"globalOperations": {
"methods": {
"aggregatedList": {
"id": "compute.globalOperations.aggregatedList",
"path": "{project}/aggregated/operations",
"httpMethod": "GET",
"description": "Retrieves an aggregated list of all operations.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"delete": {
"id": "compute.globalOperations.delete",
"path": "{project}/global/operations/{operation}",
"httpMethod": "DELETE",
"description": "Deletes the specified Operations resource.",
"parameters": {
"operation": {
"type": "string",
"description": "Name of the Operations resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"operation"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.globalOperations.get",
"path": "{project}/global/operations/{operation}",
"httpMethod": "GET",
"description": "Retrieves the specified Operations resource. Get a list of operations by making a list() request.",
"parameters": {
"operation": {
"type": "string",
"description": "Name of the Operations resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"list": {
"id": "compute.globalOperations.list",
"path": "{project}/global/operations",
"httpMethod": "GET",
"description": "Retrieves a list of Operation resources contained within the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
}
}
},
"httpHealthChecks": {
"methods": {
"delete": {
"id": "compute.httpHealthChecks.delete",
"path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
"httpMethod": "DELETE",
"description": "Deletes the specified HttpHealthCheck resource.",
"parameters": {
"httpHealthCheck": {
"type": "string",
"description": "Name of the HttpHealthCheck resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"httpHealthCheck"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.httpHealthChecks.get",
"path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
"httpMethod": "GET",
"description": "Returns the specified HttpHealthCheck resource. Get a list of available HTTP health checks by making a list() request.",
"parameters": {
"httpHealthCheck": {
"type": "string",
"description": "Name of the HttpHealthCheck resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.httpHealthChecks.insert",
"path": "{project}/global/httpHealthChecks",
"httpMethod": "POST",
"description": "Creates a HttpHealthCheck resource in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "HttpHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.httpHealthChecks.list",
"path": "{project}/global/httpHealthChecks",
"httpMethod": "GET",
"description": "Retrieves the list of HttpHealthCheck resources available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"patch": {
"id": "compute.httpHealthChecks.patch",
"path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
"httpMethod": "PATCH",
"description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.",
"parameters": {
"httpHealthCheck": {
"type": "string",
"description": "Name of the HttpHealthCheck resource to update.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"httpHealthCheck"
],
"request": {
"$ref": "HttpHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"id": "compute.httpHealthChecks.update",
"path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
"httpMethod": "PUT",
"description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request.",
"parameters": {
"httpHealthCheck": {
"type": "string",
"description": "Name of the HttpHealthCheck resource to update.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"httpHealthCheck"
],
"request": {
"$ref": "HttpHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"httpsHealthChecks": {
"methods": {
"delete": {
"id": "compute.httpsHealthChecks.delete",
"path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"httpMethod": "DELETE",
"description": "Deletes the specified HttpsHealthCheck resource.",
"parameters": {
"httpsHealthCheck": {
"type": "string",
"description": "Name of the HttpsHealthCheck resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"httpsHealthCheck"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.httpsHealthChecks.get",
"path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"httpMethod": "GET",
"description": "Returns the specified HttpsHealthCheck resource. Get a list of available HTTPS health checks by making a list() request.",
"parameters": {
"httpsHealthCheck": {
"type": "string",
"description": "Name of the HttpsHealthCheck resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.httpsHealthChecks.insert",
"path": "{project}/global/httpsHealthChecks",
"httpMethod": "POST",
"description": "Creates a HttpsHealthCheck resource in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "HttpsHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.httpsHealthChecks.list",
"path": "{project}/global/httpsHealthChecks",
"httpMethod": "GET",
"description": "Retrieves the list of HttpsHealthCheck resources available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"patch": {
"id": "compute.httpsHealthChecks.patch",
"path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"httpMethod": "PATCH",
"description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.",
"parameters": {
"httpsHealthCheck": {
"type": "string",
"description": "Name of the HttpsHealthCheck resource to update.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"httpsHealthCheck"
],
"request": {
"$ref": "HttpsHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"id": "compute.httpsHealthChecks.update",
"path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"httpMethod": "PUT",
"description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request.",
"parameters": {
"httpsHealthCheck": {
"type": "string",
"description": "Name of the HttpsHealthCheck resource to update.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"httpsHealthCheck"
],
"request": {
"$ref": "HttpsHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"images": {
"methods": {
"delete": {
"id": "compute.images.delete",
"path": "{project}/global/images/{image}",
"httpMethod": "DELETE",
"description": "Deletes the specified image.",
"parameters": {
"image": {
"type": "string",
"description": "Name of the image resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"image"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"deprecate": {
"id": "compute.images.deprecate",
"path": "{project}/global/images/{image}/deprecate",
"httpMethod": "POST",
"description": "Sets the deprecation status of an image.\n\nIf an empty request body is given, clears the deprecation status instead.",
"parameters": {
"image": {
"type": "string",
"description": "Image name.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"image"
],
"request": {
"$ref": "DeprecationStatus"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.images.get",
"path": "{project}/global/images/{image}",
"httpMethod": "GET",
"description": "Returns the specified image. Get a list of available images by making a list() request.",
"parameters": {
"image": {
"type": "string",
"description": "Name of the image resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"getFromFamily": {
"id": "compute.images.getFromFamily",
"path": "{project}/global/images/family/{family}",
"httpMethod": "GET",
"description": "Returns the latest image that is part of an image family and is not deprecated.",
"parameters": {
"family": {
"type": "string",
"description": "Name of the image resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.images.insert",
"path": "{project}/global/images",
"httpMethod": "POST",
"description": "Creates an image in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"list": {
"id": "compute.images.list",
"path": "{project}/global/images",
"httpMethod": "GET",
"description": "Retrieves the list of private images available to the specified project. Private 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 7. 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.\n\nSee Accessing images for more information.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
}
}
},
"instanceGroupManagers": {
"methods": {
"abandonInstances": {
"id": "compute.instanceGroupManagers.abandonInstances",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
"httpMethod": "POST",
"description": "Schedules a group action to remove the specified instances 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.",
"parameters": {
"instanceGroupManager": {
"type": "string",
"description": "The name of the managed instance group.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the managed instance group is located.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"request": {
"$ref": "InstanceGroupManagersAbandonInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"aggregatedList": {
"id": "compute.instanceGroupManagers.aggregatedList",
"path": "{project}/aggregated/instanceGroupManagers",
"httpMethod": "GET",
"description": "Retrieves the list of managed instance groups and groups them by zone.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"delete": {
"id": "compute.instanceGroupManagers.delete",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
"httpMethod": "DELETE",
"description": "Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.",
"parameters": {
"instanceGroupManager": {
"type": "string",
"description": "The name of the managed instance group to delete.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the managed instance group is located.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"deleteInstances": {
"id": "compute.instanceGroupManagers.deleteInstances",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
"httpMethod": "POST",
"description": "Schedules a group action to delete the specified instances in the managed instance group. 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.",
"parameters": {
"instanceGroupManager": {
"type": "string",
"description": "The name of the managed instance group.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the managed instance group is located.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"request": {
"$ref": "InstanceGroupManagersDeleteInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.instanceGroupManagers.get",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
"httpMethod": "GET",
"description": "Returns all of the details about the specified managed instance group. Get a list of available managed instance groups by making a list() request.",
"parameters": {
"instanceGroupManager": {
"type": "string",
"description": "The name of the managed instance group.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the managed instance group is located.",
"required": true,
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.instanceGroupManagers.insert",
"path": "{project}/zones/{zone}/instanceGroupManagers",
"httpMethod": "POST",
"description": "Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group 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.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where you want to create the managed instance group.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"zone"
],
"request": {
"$ref": "InstanceGroupManager"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.instanceGroupManagers.list",
"path": "{project}/zones/{zone}/instanceGroupManagers",
"httpMethod": "GET",
"description": "Retrieves a list of managed instance groups that are contained within the specified project and zone.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the managed instance group is located.",
"required": true,
"location": "path"
}
},
"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"
]
},
"listManagedInstances": {
"id": "compute.instanceGroupManagers.listManagedInstances",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
"httpMethod": "POST",
"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.",
"parameters": {
"instanceGroupManager": {
"type": "string",
"description": "The name of the managed instance group.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the managed instance group is located.",
"required": true,
"location": "path"
}
},
"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"
]
},
"recreateInstances": {
"id": "compute.instanceGroupManagers.recreateInstances",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
"httpMethod": "POST",
"description": "Schedules a group action to recreate the specified instances in the managed instance group. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the action is scheduled even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.",
"parameters": {
"instanceGroupManager": {
"type": "string",
"description": "The name of the managed instance group.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the managed instance group is located.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"request": {
"$ref": "InstanceGroupManagersRecreateInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"resize": {
"id": "compute.instanceGroupManagers.resize",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize",
"httpMethod": "POST",
"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.",
"parameters": {
"instanceGroupManager": {
"type": "string",
"description": "The name of the managed instance group.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"size": {
"type": "integer",
"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.",
"required": true,
"format": "int32",
"location": "query"
},
"zone": {
"type": "string",
"description": "The name of the zone where the managed instance group is located.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instanceGroupManager",
"size"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setInstanceTemplate": {
"id": "compute.instanceGroupManagers.setInstanceTemplate",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
"httpMethod": "POST",
"description": "Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.",
"parameters": {
"instanceGroupManager": {
"type": "string",
"description": "The name of the managed instance group.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the managed instance group is located.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"request": {
"$ref": "InstanceGroupManagersSetInstanceTemplateRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setTargetPools": {
"id": "compute.instanceGroupManagers.setTargetPools",
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
"httpMethod": "POST",
"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.",
"parameters": {
"instanceGroupManager": {
"type": "string",
"description": "The name of the managed instance group.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the managed instance group is located.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"request": {
"$ref": "InstanceGroupManagersSetTargetPoolsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"instanceGroups": {
"methods": {
"addInstances": {
"id": "compute.instanceGroups.addInstances",
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances",
"httpMethod": "POST",
"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.",
"parameters": {
"instanceGroup": {
"type": "string",
"description": "The name of the instance group where you are adding instances.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the instance group is located.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instanceGroup"
],
"request": {
"$ref": "InstanceGroupsAddInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"aggregatedList": {
"id": "compute.instanceGroups.aggregatedList",
"path": "{project}/aggregated/instanceGroups",
"httpMethod": "GET",
"description": "Retrieves the list of instance groups and sorts them by zone.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"delete": {
"id": "compute.instanceGroups.delete",
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}",
"httpMethod": "DELETE",
"description": "Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.",
"parameters": {
"instanceGroup": {
"type": "string",
"description": "The name of the instance group to delete.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the instance group is located.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instanceGroup"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.instanceGroups.get",
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}",
"httpMethod": "GET",
"description": "Returns the specified instance group. Get a list of available instance groups by making a list() request.",
"parameters": {
"instanceGroup": {
"type": "string",
"description": "The name of the instance group.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the instance group is located.",
"required": true,
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.instanceGroups.insert",
"path": "{project}/zones/{zone}/instanceGroups",
"httpMethod": "POST",
"description": "Creates an instance group in the specified project using the parameters that are included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where you want to create the instance group.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"zone"
],
"request": {
"$ref": "InstanceGroup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.instanceGroups.list",
"path": "{project}/zones/{zone}/instanceGroups",
"httpMethod": "GET",
"description": "Retrieves the list of instance groups that are located in the specified project and zone.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the instance group is located.",
"required": true,
"location": "path"
}
},
"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"
]
},
"listInstances": {
"id": "compute.instanceGroups.listInstances",
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances",
"httpMethod": "POST",
"description": "Lists the instances in the specified instance group.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"instanceGroup": {
"type": "string",
"description": "The name of the instance group from which you want to generate a list of included instances.",
"required": true,
"location": "path"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the instance group is located.",
"required": true,
"location": "path"
}
},
"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"
]
},
"removeInstances": {
"id": "compute.instanceGroups.removeInstances",
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances",
"httpMethod": "POST",
"description": "Removes one or more instances from the specified instance group, but does not delete those instances.",
"parameters": {
"instanceGroup": {
"type": "string",
"description": "The name of the instance group where the specified instances will be removed.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the instance group is located.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instanceGroup"
],
"request": {
"$ref": "InstanceGroupsRemoveInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setNamedPorts": {
"id": "compute.instanceGroups.setNamedPorts",
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts",
"httpMethod": "POST",
"description": "Sets the named ports for the specified instance group.",
"parameters": {
"instanceGroup": {
"type": "string",
"description": "The name of the instance group where the named ports are updated.",
"required": true,
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone where the instance group is located.",
"required": true,
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instanceGroup"
],
"request": {
"$ref": "InstanceGroupsSetNamedPortsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"instanceTemplates": {
"methods": {
"delete": {
"id": "compute.instanceTemplates.delete",
"path": "{project}/global/instanceTemplates/{instanceTemplate}",
"httpMethod": "DELETE",
"description": "Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.",
"parameters": {
"instanceTemplate": {
"type": "string",
"description": "The name of the instance template to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"instanceTemplate"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.instanceTemplates.get",
"path": "{project}/global/instanceTemplates/{instanceTemplate}",
"httpMethod": "GET",
"description": "Returns the specified instance template. Get a list of available instance templates by making a list() request.",
"parameters": {
"instanceTemplate": {
"type": "string",
"description": "The name of the instance template.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.instanceTemplates.insert",
"path": "{project}/global/instanceTemplates",
"httpMethod": "POST",
"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.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "InstanceTemplate"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.instanceTemplates.list",
"path": "{project}/global/instanceTemplates",
"httpMethod": "GET",
"description": "Retrieves a list of instance templates that are contained within the specified project and zone.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
}
}
},
"instances": {
"methods": {
"addAccessConfig": {
"id": "compute.instances.addAccessConfig",
"path": "{project}/zones/{zone}/instances/{instance}/addAccessConfig",
"httpMethod": "POST",
"description": "Adds an access config to an instance's network interface.",
"parameters": {
"instance": {
"type": "string",
"description": "The instance name for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"networkInterface": {
"type": "string",
"description": "The name of the network interface to add to this instance.",
"required": true,
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"aggregatedList": {
"id": "compute.instances.aggregatedList",
"path": "{project}/aggregated/instances",
"httpMethod": "GET",
"description": "Retrieves aggregated list of instances.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"attachDisk": {
"id": "compute.instances.attachDisk",
"path": "{project}/zones/{zone}/instances/{instance}/attachDisk",
"httpMethod": "POST",
"description": "Attaches a Disk resource to an instance.",
"parameters": {
"instance": {
"type": "string",
"description": "The instance name for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instance"
],
"request": {
"$ref": "AttachedDisk"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"id": "compute.instances.delete",
"path": "{project}/zones/{zone}/instances/{instance}",
"httpMethod": "DELETE",
"description": "Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.",
"parameters": {
"instance": {
"type": "string",
"description": "Name of the instance resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instance"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"deleteAccessConfig": {
"id": "compute.instances.deleteAccessConfig",
"path": "{project}/zones/{zone}/instances/{instance}/deleteAccessConfig",
"httpMethod": "POST",
"description": "Deletes an access config from an instance's network interface.",
"parameters": {
"accessConfig": {
"type": "string",
"description": "The name of the access config to delete.",
"required": true,
"location": "query"
},
"instance": {
"type": "string",
"description": "The instance name for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"networkInterface": {
"type": "string",
"description": "The name of the network interface.",
"required": true,
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instance",
"accessConfig",
"networkInterface"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"detachDisk": {
"id": "compute.instances.detachDisk",
"path": "{project}/zones/{zone}/instances/{instance}/detachDisk",
"httpMethod": "POST",
"description": "Detaches a disk from an instance.",
"parameters": {
"deviceName": {
"type": "string",
"description": "Disk device name to detach.",
"required": true,
"pattern": "\\w[\\w.-]{0,254}",
"location": "query"
},
"instance": {
"type": "string",
"description": "Instance name.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instance",
"deviceName"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.instances.get",
"path": "{project}/zones/{zone}/instances/{instance}",
"httpMethod": "GET",
"description": "Returns the specified Instance resource. Get a list of available instances by making a list() request.",
"parameters": {
"instance": {
"type": "string",
"description": "Name of the instance resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"getSerialPortOutput": {
"id": "compute.instances.getSerialPortOutput",
"path": "{project}/zones/{zone}/instances/{instance}/serialPort",
"httpMethod": "GET",
"description": "Returns the specified instance's serial port output.",
"parameters": {
"instance": {
"type": "string",
"description": "Name of the instance scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"port": {
"type": "integer",
"description": "Specifies which COM or serial port to retrieve data from.",
"default": "1",
"format": "int32",
"minimum": "1",
"maximum": "4",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.instances.insert",
"path": "{project}/zones/{zone}/instances",
"httpMethod": "POST",
"description": "Creates an instance resource in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone"
],
"request": {
"$ref": "Instance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.instances.list",
"path": "{project}/zones/{zone}/instances",
"httpMethod": "GET",
"description": "Retrieves the list of instances contained within the specified zone.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"reset": {
"id": "compute.instances.reset",
"path": "{project}/zones/{zone}/instances/{instance}/reset",
"httpMethod": "POST",
"description": "Performs a hard reset on the instance.",
"parameters": {
"instance": {
"type": "string",
"description": "Name of the instance scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instance"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setDiskAutoDelete": {
"id": "compute.instances.setDiskAutoDelete",
"path": "{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
"httpMethod": "POST",
"description": "Sets the auto-delete flag for a disk attached to an instance.",
"parameters": {
"autoDelete": {
"type": "boolean",
"description": "Whether to auto-delete the disk when the instance is deleted.",
"required": true,
"location": "query"
},
"deviceName": {
"type": "string",
"description": "The device name of the disk to modify.",
"required": true,
"pattern": "\\w[\\w.-]{0,254}",
"location": "query"
},
"instance": {
"type": "string",
"description": "The instance name.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instance",
"autoDelete",
"deviceName"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setMachineType": {
"id": "compute.instances.setMachineType",
"path": "{project}/zones/{zone}/instances/{instance}/setMachineType",
"httpMethod": "POST",
"description": "Changes the machine type for a stopped instance to the machine type specified in the request.",
"parameters": {
"instance": {
"type": "string",
"description": "Name of the instance scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instance"
],
"request": {
"$ref": "InstancesSetMachineTypeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setMetadata": {
"id": "compute.instances.setMetadata",
"path": "{project}/zones/{zone}/instances/{instance}/setMetadata",
"httpMethod": "POST",
"description": "Sets metadata for the specified instance to the data included in the request.",
"parameters": {
"instance": {
"type": "string",
"description": "Name of the instance scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instance"
],
"request": {
"$ref": "Metadata"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setScheduling": {
"id": "compute.instances.setScheduling",
"path": "{project}/zones/{zone}/instances/{instance}/setScheduling",
"httpMethod": "POST",
"description": "Sets an instance's scheduling options.",
"parameters": {
"instance": {
"type": "string",
"description": "Instance name.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instance"
],
"request": {
"$ref": "Scheduling"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setTags": {
"id": "compute.instances.setTags",
"path": "{project}/zones/{zone}/instances/{instance}/setTags",
"httpMethod": "POST",
"description": "Sets tags for the specified instance to the data included in the request.",
"parameters": {
"instance": {
"type": "string",
"description": "Name of the instance scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instance"
],
"request": {
"$ref": "Tags"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"start": {
"id": "compute.instances.start",
"path": "{project}/zones/{zone}/instances/{instance}/start",
"httpMethod": "POST",
"description": "Starts an instance that was stopped using the using the instances().stop method. For more information, see Restart an instance.",
"parameters": {
"instance": {
"type": "string",
"description": "Name of the instance resource to start.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instance"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"stop": {
"id": "compute.instances.stop",
"path": "{project}/zones/{zone}/instances/{instance}/stop",
"httpMethod": "POST",
"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 per-minute, virtual machine usage charges while they are stopped, but any resources that the virtual machine 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.",
"parameters": {
"instance": {
"type": "string",
"description": "Name of the instance resource to stop.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"instance"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"licenses": {
"methods": {
"get": {
"id": "compute.licenses.get",
"path": "{project}/global/licenses/{license}",
"httpMethod": "GET",
"description": "Returns the specified License resource. Get a list of available licenses by making a list() request.",
"parameters": {
"license": {
"type": "string",
"description": "Name of the License resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
}
}
},
"machineTypes": {
"methods": {
"aggregatedList": {
"id": "compute.machineTypes.aggregatedList",
"path": "{project}/aggregated/machineTypes",
"httpMethod": "GET",
"description": "Retrieves an aggregated list of machine types.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"get": {
"id": "compute.machineTypes.get",
"path": "{project}/zones/{zone}/machineTypes/{machineType}",
"httpMethod": "GET",
"description": "Returns the specified machine type. Get a list of available machine types by making a list() request.",
"parameters": {
"machineType": {
"type": "string",
"description": "Name of the machine type to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"list": {
"id": "compute.machineTypes.list",
"path": "{project}/zones/{zone}/machineTypes",
"httpMethod": "GET",
"description": "Retrieves a list of machine types available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "The name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
}
}
},
"networks": {
"methods": {
"delete": {
"id": "compute.networks.delete",
"path": "{project}/global/networks/{network}",
"httpMethod": "DELETE",
"description": "Deletes the specified network.",
"parameters": {
"network": {
"type": "string",
"description": "Name of the network to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project",
"network"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.networks.get",
"path": "{project}/global/networks/{network}",
"httpMethod": "GET",
"description": "Returns the specified network. Get a list of available networks by making a list() request.",
"parameters": {
"network": {
"type": "string",
"description": "Name of the network to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.networks.insert",
"path": "{project}/global/networks",
"httpMethod": "POST",
"description": "Creates a network in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "Network"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.networks.list",
"path": "{project}/global/networks",
"httpMethod": "GET",
"description": "Retrieves the list of networks available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
}
}
},
"projects": {
"methods": {
"get": {
"id": "compute.projects.get",
"path": "{project}",
"httpMethod": "GET",
"description": "Returns the specified Project resource.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"moveDisk": {
"id": "compute.projects.moveDisk",
"path": "{project}/moveDisk",
"httpMethod": "POST",
"description": "Moves a persistent disk from one zone to another.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "DiskMoveRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"moveInstance": {
"id": "compute.projects.moveInstance",
"path": "{project}/moveInstance",
"httpMethod": "POST",
"description": "Moves an instance and its attached persistent disks from one zone to another.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "InstanceMoveRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setCommonInstanceMetadata": {
"id": "compute.projects.setCommonInstanceMetadata",
"path": "{project}/setCommonInstanceMetadata",
"httpMethod": "POST",
"description": "Sets metadata common to all instances within the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "Metadata"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setUsageExportBucket": {
"id": "compute.projects.setUsageExportBucket",
"path": "{project}/setUsageExportBucket",
"httpMethod": "POST",
"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.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
}
}
},
"regionOperations": {
"methods": {
"delete": {
"id": "compute.regionOperations.delete",
"path": "{project}/regions/{region}/operations/{operation}",
"httpMethod": "DELETE",
"description": "Deletes the specified region-specific Operations resource.",
"parameters": {
"operation": {
"type": "string",
"description": "Name of the Operations resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region",
"operation"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.regionOperations.get",
"path": "{project}/regions/{region}/operations/{operation}",
"httpMethod": "GET",
"description": "Retrieves the specified region-specific Operations resource.",
"parameters": {
"operation": {
"type": "string",
"description": "Name of the Operations resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"list": {
"id": "compute.regionOperations.list",
"path": "{project}/regions/{region}/operations",
"httpMethod": "GET",
"description": "Retrieves a list of Operation resources contained within the specified region.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
}
}
},
"regions": {
"methods": {
"get": {
"id": "compute.regions.get",
"path": "{project}/regions/{region}",
"httpMethod": "GET",
"description": "Returns the specified Region resource. Get a list of available regions by making a list() request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"list": {
"id": "compute.regions.list",
"path": "{project}/regions",
"httpMethod": "GET",
"description": "Retrieves the list of region resources available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
}
}
},
"routes": {
"methods": {
"delete": {
"id": "compute.routes.delete",
"path": "{project}/global/routes/{route}",
"httpMethod": "DELETE",
"description": "Deletes the specified Route resource.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"route": {
"type": "string",
"description": "Name of the Route resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"route"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.routes.get",
"path": "{project}/global/routes/{route}",
"httpMethod": "GET",
"description": "Returns the specified Route resource. Get a list of available routes by making a list() request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"route": {
"type": "string",
"description": "Name of the Route resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.routes.insert",
"path": "{project}/global/routes",
"httpMethod": "POST",
"description": "Creates a Route resource in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "Route"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.routes.list",
"path": "{project}/global/routes",
"httpMethod": "GET",
"description": "Retrieves the list of Route resources available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
}
}
},
"snapshots": {
"methods": {
"delete": {
"id": "compute.snapshots.delete",
"path": "{project}/global/snapshots/{snapshot}",
"httpMethod": "DELETE",
"description": "Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.\n\nFor more information, see Deleting snaphots.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"snapshot": {
"type": "string",
"description": "Name of the Snapshot resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"snapshot"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.snapshots.get",
"path": "{project}/global/snapshots/{snapshot}",
"httpMethod": "GET",
"description": "Returns the specified Snapshot resource. Get a list of available snapshots by making a list() request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"snapshot": {
"type": "string",
"description": "Name of the Snapshot resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"list": {
"id": "compute.snapshots.list",
"path": "{project}/global/snapshots",
"httpMethod": "GET",
"description": "Retrieves the list of Snapshot resources contained within the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
}
}
},
"sslCertificates": {
"methods": {
"delete": {
"id": "compute.sslCertificates.delete",
"path": "{project}/global/sslCertificates/{sslCertificate}",
"httpMethod": "DELETE",
"description": "Deletes the specified SslCertificate resource.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"sslCertificate": {
"type": "string",
"description": "Name of the SslCertificate resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"sslCertificate"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.sslCertificates.get",
"path": "{project}/global/sslCertificates/{sslCertificate}",
"httpMethod": "GET",
"description": "Returns the specified SslCertificate resource. Get a list of available SSL certificates by making a list() request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"sslCertificate": {
"type": "string",
"description": "Name of the SslCertificate resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.sslCertificates.insert",
"path": "{project}/global/sslCertificates",
"httpMethod": "POST",
"description": "Creates a SslCertificate resource in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "SslCertificate"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.sslCertificates.list",
"path": "{project}/global/sslCertificates",
"httpMethod": "GET",
"description": "Retrieves the list of SslCertificate resources available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
}
}
},
"subnetworks": {
"methods": {
"aggregatedList": {
"id": "compute.subnetworks.aggregatedList",
"path": "{project}/aggregated/subnetworks",
"httpMethod": "GET",
"description": "Retrieves an aggregated list of subnetworks.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"delete": {
"id": "compute.subnetworks.delete",
"path": "{project}/regions/{region}/subnetworks/{subnetwork}",
"httpMethod": "DELETE",
"description": "Deletes the specified subnetwork.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"subnetwork": {
"type": "string",
"description": "Name of the Subnetwork resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region",
"subnetwork"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.subnetworks.get",
"path": "{project}/regions/{region}/subnetworks/{subnetwork}",
"httpMethod": "GET",
"description": "Returns the specified subnetwork. Get a list of available subnetworks list() request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"subnetwork": {
"type": "string",
"description": "Name of the Subnetwork resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.subnetworks.insert",
"path": "{project}/regions/{region}/subnetworks",
"httpMethod": "POST",
"description": "Creates a subnetwork in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region"
],
"request": {
"$ref": "Subnetwork"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.subnetworks.list",
"path": "{project}/regions/{region}/subnetworks",
"httpMethod": "GET",
"description": "Retrieves a list of subnetworks available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
}
}
},
"targetHttpProxies": {
"methods": {
"delete": {
"id": "compute.targetHttpProxies.delete",
"path": "{project}/global/targetHttpProxies/{targetHttpProxy}",
"httpMethod": "DELETE",
"description": "Deletes the specified TargetHttpProxy resource.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"targetHttpProxy": {
"type": "string",
"description": "Name of the TargetHttpProxy resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"targetHttpProxy"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.targetHttpProxies.get",
"path": "{project}/global/targetHttpProxies/{targetHttpProxy}",
"httpMethod": "GET",
"description": "Returns the specified TargetHttpProxy resource. Get a list of available target HTTP proxies by making a list() request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"targetHttpProxy": {
"type": "string",
"description": "Name of the TargetHttpProxy resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.targetHttpProxies.insert",
"path": "{project}/global/targetHttpProxies",
"httpMethod": "POST",
"description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "TargetHttpProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.targetHttpProxies.list",
"path": "{project}/global/targetHttpProxies",
"httpMethod": "GET",
"description": "Retrieves the list of TargetHttpProxy resources available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"setUrlMap": {
"id": "compute.targetHttpProxies.setUrlMap",
"path": "{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
"httpMethod": "POST",
"description": "Changes the URL map for TargetHttpProxy.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"targetHttpProxy": {
"type": "string",
"description": "Name of the TargetHttpProxy to set a URL map for.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"targetHttpProxy"
],
"request": {
"$ref": "UrlMapReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"targetHttpsProxies": {
"methods": {
"delete": {
"id": "compute.targetHttpsProxies.delete",
"path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}",
"httpMethod": "DELETE",
"description": "Deletes the specified TargetHttpsProxy resource.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"targetHttpsProxy": {
"type": "string",
"description": "Name of the TargetHttpsProxy resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"targetHttpsProxy"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.targetHttpsProxies.get",
"path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}",
"httpMethod": "GET",
"description": "Returns the specified TargetHttpsProxy resource. Get a list of available target HTTPS proxies by making a list() request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"targetHttpsProxy": {
"type": "string",
"description": "Name of the TargetHttpsProxy resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.targetHttpsProxies.insert",
"path": "{project}/global/targetHttpsProxies",
"httpMethod": "POST",
"description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "TargetHttpsProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.targetHttpsProxies.list",
"path": "{project}/global/targetHttpsProxies",
"httpMethod": "GET",
"description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"setSslCertificates": {
"id": "compute.targetHttpsProxies.setSslCertificates",
"path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
"httpMethod": "POST",
"description": "Replaces SslCertificates for TargetHttpsProxy.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"targetHttpsProxy": {
"type": "string",
"description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"targetHttpsProxy"
],
"request": {
"$ref": "TargetHttpsProxiesSetSslCertificatesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setUrlMap": {
"id": "compute.targetHttpsProxies.setUrlMap",
"path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
"httpMethod": "POST",
"description": "Changes the URL map for TargetHttpsProxy.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"targetHttpsProxy": {
"type": "string",
"description": "Name of the TargetHttpsProxy resource whose URL map is to be set.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"targetHttpsProxy"
],
"request": {
"$ref": "UrlMapReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"targetInstances": {
"methods": {
"aggregatedList": {
"id": "compute.targetInstances.aggregatedList",
"path": "{project}/aggregated/targetInstances",
"httpMethod": "GET",
"description": "Retrieves an aggregated list of target instances.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"delete": {
"id": "compute.targetInstances.delete",
"path": "{project}/zones/{zone}/targetInstances/{targetInstance}",
"httpMethod": "DELETE",
"description": "Deletes the specified TargetInstance resource.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"targetInstance": {
"type": "string",
"description": "Name of the TargetInstance resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"targetInstance"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.targetInstances.get",
"path": "{project}/zones/{zone}/targetInstances/{targetInstance}",
"httpMethod": "GET",
"description": "Returns the specified TargetInstance resource. Get a list of available target instances by making a list() request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"targetInstance": {
"type": "string",
"description": "Name of the TargetInstance resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.targetInstances.insert",
"path": "{project}/zones/{zone}/targetInstances",
"httpMethod": "POST",
"description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone"
],
"request": {
"$ref": "TargetInstance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.targetInstances.list",
"path": "{project}/zones/{zone}/targetInstances",
"httpMethod": "GET",
"description": "Retrieves a list of TargetInstance resources available to the specified project and zone.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
}
}
},
"targetPools": {
"methods": {
"addHealthCheck": {
"id": "compute.targetPools.addHealthCheck",
"path": "{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck",
"httpMethod": "POST",
"description": "Adds health check URLs to a target pool.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"targetPool": {
"type": "string",
"description": "Name of the target pool to add a health check to.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region",
"targetPool"
],
"request": {
"$ref": "TargetPoolsAddHealthCheckRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"addInstance": {
"id": "compute.targetPools.addInstance",
"path": "{project}/regions/{region}/targetPools/{targetPool}/addInstance",
"httpMethod": "POST",
"description": "Adds an instance to a target pool.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"targetPool": {
"type": "string",
"description": "Name of the TargetPool resource to add instances to.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region",
"targetPool"
],
"request": {
"$ref": "TargetPoolsAddInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"aggregatedList": {
"id": "compute.targetPools.aggregatedList",
"path": "{project}/aggregated/targetPools",
"httpMethod": "GET",
"description": "Retrieves an aggregated list of target pools.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"delete": {
"id": "compute.targetPools.delete",
"path": "{project}/regions/{region}/targetPools/{targetPool}",
"httpMethod": "DELETE",
"description": "Deletes the specified target pool.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"targetPool": {
"type": "string",
"description": "Name of the TargetPool resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region",
"targetPool"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.targetPools.get",
"path": "{project}/regions/{region}/targetPools/{targetPool}",
"httpMethod": "GET",
"description": "Returns the specified target pool. Get a list of available target pools by making a list() request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"targetPool": {
"type": "string",
"description": "Name of the TargetPool resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"getHealth": {
"id": "compute.targetPools.getHealth",
"path": "{project}/regions/{region}/targetPools/{targetPool}/getHealth",
"httpMethod": "POST",
"description": "Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"targetPool": {
"type": "string",
"description": "Name of the TargetPool resource to which the queried instance belongs.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.targetPools.insert",
"path": "{project}/regions/{region}/targetPools",
"httpMethod": "POST",
"description": "Creates a target pool in the specified project and region using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region"
],
"request": {
"$ref": "TargetPool"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.targetPools.list",
"path": "{project}/regions/{region}/targetPools",
"httpMethod": "GET",
"description": "Retrieves a list of target pools available to the specified project and region.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"removeHealthCheck": {
"id": "compute.targetPools.removeHealthCheck",
"path": "{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck",
"httpMethod": "POST",
"description": "Removes health check URL from a target pool.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"targetPool": {
"type": "string",
"description": "Name of the target pool to remove health checks from.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region",
"targetPool"
],
"request": {
"$ref": "TargetPoolsRemoveHealthCheckRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"removeInstance": {
"id": "compute.targetPools.removeInstance",
"path": "{project}/regions/{region}/targetPools/{targetPool}/removeInstance",
"httpMethod": "POST",
"description": "Removes instance URL from a target pool.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"targetPool": {
"type": "string",
"description": "Name of the TargetPool resource to remove instances from.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region",
"targetPool"
],
"request": {
"$ref": "TargetPoolsRemoveInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setBackup": {
"id": "compute.targetPools.setBackup",
"path": "{project}/regions/{region}/targetPools/{targetPool}/setBackup",
"httpMethod": "POST",
"description": "Changes a backup target pool's configurations.",
"parameters": {
"failoverRatio": {
"type": "number",
"description": "New failoverRatio value for the target pool.",
"format": "float",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region scoping this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"targetPool": {
"type": "string",
"description": "Name of the TargetPool resource to set a backup pool for.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region",
"targetPool"
],
"request": {
"$ref": "TargetReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"targetVpnGateways": {
"methods": {
"aggregatedList": {
"id": "compute.targetVpnGateways.aggregatedList",
"path": "{project}/aggregated/targetVpnGateways",
"httpMethod": "GET",
"description": "Retrieves an aggregated list of target VPN gateways.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"delete": {
"id": "compute.targetVpnGateways.delete",
"path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
"httpMethod": "DELETE",
"description": "Deletes the specified target VPN gateway.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"targetVpnGateway": {
"type": "string",
"description": "Name of the target VPN gateway to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region",
"targetVpnGateway"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.targetVpnGateways.get",
"path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
"httpMethod": "GET",
"description": "Returns the specified target VPN gateway. Get a list of available target VPN gateways by making a list() request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"targetVpnGateway": {
"type": "string",
"description": "Name of the target VPN gateway to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.targetVpnGateways.insert",
"path": "{project}/regions/{region}/targetVpnGateways",
"httpMethod": "POST",
"description": "Creates a target VPN gateway in the specified project and region using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region"
],
"request": {
"$ref": "TargetVpnGateway"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.targetVpnGateways.list",
"path": "{project}/regions/{region}/targetVpnGateways",
"httpMethod": "GET",
"description": "Retrieves a list of target VPN gateways available to the specified project and region.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
}
}
},
"urlMaps": {
"methods": {
"delete": {
"id": "compute.urlMaps.delete",
"path": "{project}/global/urlMaps/{urlMap}",
"httpMethod": "DELETE",
"description": "Deletes the specified UrlMap resource.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"urlMap": {
"type": "string",
"description": "Name of the UrlMap resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"urlMap"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.urlMaps.get",
"path": "{project}/global/urlMaps/{urlMap}",
"httpMethod": "GET",
"description": "Returns the specified UrlMap resource. Get a list of available URL maps by making a list() request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"urlMap": {
"type": "string",
"description": "Name of the UrlMap resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.urlMaps.insert",
"path": "{project}/global/urlMaps",
"httpMethod": "POST",
"description": "Creates a UrlMap resource in the specified project using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"parameterOrder": [
"project"
],
"request": {
"$ref": "UrlMap"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.urlMaps.list",
"path": "{project}/global/urlMaps",
"httpMethod": "GET",
"description": "Retrieves the list of UrlMap resources available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"patch": {
"id": "compute.urlMaps.patch",
"path": "{project}/global/urlMaps/{urlMap}",
"httpMethod": "PATCH",
"description": "Updates the entire content of the UrlMap resource. This method supports patch semantics.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"urlMap": {
"type": "string",
"description": "Name of the UrlMap resource to update.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"urlMap"
],
"request": {
"$ref": "UrlMap"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"id": "compute.urlMaps.update",
"path": "{project}/global/urlMaps/{urlMap}",
"httpMethod": "PUT",
"description": "Updates the entire content of the UrlMap resource.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"urlMap": {
"type": "string",
"description": "Name of the UrlMap resource to update.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"urlMap"
],
"request": {
"$ref": "UrlMap"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"validate": {
"id": "compute.urlMaps.validate",
"path": "{project}/global/urlMaps/{urlMap}/validate",
"httpMethod": "POST",
"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.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"urlMap": {
"type": "string",
"description": "Name of the UrlMap resource to be validated as.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"urlMap"
],
"request": {
"$ref": "UrlMapsValidateRequest"
},
"response": {
"$ref": "UrlMapsValidateResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"vpnTunnels": {
"methods": {
"aggregatedList": {
"id": "compute.vpnTunnels.aggregatedList",
"path": "{project}/aggregated/vpnTunnels",
"httpMethod": "GET",
"description": "Retrieves an aggregated list of VPN tunnels.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
},
"delete": {
"id": "compute.vpnTunnels.delete",
"path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
"httpMethod": "DELETE",
"description": "Deletes the specified VpnTunnel resource.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"vpnTunnel": {
"type": "string",
"description": "Name of the VpnTunnel resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region",
"vpnTunnel"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.vpnTunnels.get",
"path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
"httpMethod": "GET",
"description": "Returns the specified VpnTunnel resource. Get a list of available VPN tunnels by making a list() request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"vpnTunnel": {
"type": "string",
"description": "Name of the VpnTunnel resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"insert": {
"id": "compute.vpnTunnels.insert",
"path": "{project}/regions/{region}/vpnTunnels",
"httpMethod": "POST",
"description": "Creates a VpnTunnel resource in the specified project and region using the data included in the request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"region"
],
"request": {
"$ref": "VpnTunnel"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"id": "compute.vpnTunnels.list",
"path": "{project}/regions/{region}/vpnTunnels",
"httpMethod": "GET",
"description": "Retrieves a list of VpnTunnel resources contained in the specified project and region.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"region": {
"type": "string",
"description": "Name of the region for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
}
}
},
"zoneOperations": {
"methods": {
"delete": {
"id": "compute.zoneOperations.delete",
"path": "{project}/zones/{zone}/operations/{operation}",
"httpMethod": "DELETE",
"description": "Deletes the specified zone-specific Operations resource.",
"parameters": {
"operation": {
"type": "string",
"description": "Name of the Operations resource to delete.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"parameterOrder": [
"project",
"zone",
"operation"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"id": "compute.zoneOperations.get",
"path": "{project}/zones/{zone}/operations/{operation}",
"httpMethod": "GET",
"description": "Retrieves the specified zone-specific Operations resource.",
"parameters": {
"operation": {
"type": "string",
"description": "Name of the Operations resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone for this request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"list": {
"id": "compute.zoneOperations.list",
"path": "{project}/zones/{zone}/operations",
"httpMethod": "GET",
"description": "Retrieves a list of Operation resources contained within the specified zone.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone for request.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
}
}
},
"zones": {
"methods": {
"get": {
"id": "compute.zones.get",
"path": "{project}/zones/{zone}",
"httpMethod": "GET",
"description": "Returns the specified Zone resource. Get a list of available zones by making a list() request.",
"parameters": {
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
},
"zone": {
"type": "string",
"description": "Name of the zone resource to return.",
"required": true,
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"location": "path"
}
},
"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"
]
},
"list": {
"id": "compute.zones.list",
"path": "{project}/zones",
"httpMethod": "GET",
"description": "Retrieves the list of Zone resources available to the specified project.",
"parameters": {
"filter": {
"type": "string",
"description": "Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.\n\nThe field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.\n\nFor example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.\n\nCompute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.\n\nThe Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.",
"location": "query"
},
"maxResults": {
"type": "integer",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests.",
"default": "500",
"format": "uint32",
"minimum": "0",
"maximum": "500",
"location": "query"
},
"pageToken": {
"type": "string",
"description": "Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.",
"location": "query"
},
"project": {
"type": "string",
"description": "Project ID for this request.",
"required": true,
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"location": "path"
}
},
"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"
]
}
}
}
}
}
Reference in a new issue View git blame Copy permalink