{"note":"OpenAPI conversion -- returning structured metadata","name":"gcp-compute","description":"Compute Engine API","version":"v1","base_url":"https://compute.googleapis.com/compute/v1","endpoints":694,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Compute Engine API\n@base https://compute.googleapis.com/compute/v1\n@version v1\n@auth OAuth2 | OAuth2\n@common_fields {project: str # Project ID for this request.}\n@endpoints 694\n@hint download_for_search\n@toc locations(21), projects(673)\n\n@group locations\n@endpoint GET /locations/global/firewallPolicies\n@desc Lists all the policies that have been configured for the specified folder or organization.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., parentId: str # Parent ID for this request. The ID can be either be \"folders/[FOLDER_ID]\" if the parent is a folder or \"organizations/[ORGANIZATION_ID]\" if the parent is an organization., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /locations/global/firewallPolicies\n@desc Creates a new policy in the specified project using the data included in the request.\n@optional {parentId: str # Parent ID for this request. The ID can be either be \"folders/[FOLDER_ID]\" if the parent is a folder or \"organizations/[ORGANIZATION_ID]\" if the parent is an organization., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., associations: [map{attachmentTarget: str, displayName: str, firewallPolicyId: str, name: str, shortName: str}] # A list of associations that belong to this firewall policy., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., displayName: str # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., fingerprint: str(byte) # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#firewallPolicy # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies, name: str # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy., parent: str # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies., region: str # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., ruleTupleCount: int(int32) # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples., rules: [map{action: str, description: str, direction: str, disabled: bool, enableLogging: bool, kind: str, match: map, priority: int(int32), ruleName: str, ruleTupleCount: int(int32), targetResources: [str], targetSecureTags: [map], targetServiceAccounts: [str]}] # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match \"*\"). If no rules are provided when creating a firewall policy, a default rule with action \"allow\" will be added., selfLink: str # [Output Only] Server-defined URL for the resource., selfLinkWithId: str # [Output Only] Server-defined URL for this resource with the resource id., shortName: str # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /locations/global/firewallPolicies/listAssociations\n@desc Lists associations of a specified target, i.e., organization or folder.\n@optional {targetResource: str # The target resource to list associations. It is an organization, or a folder.}\n@returns(200) {associations: [map], kind: str} # Successful response\n\n@endpoint DELETE /locations/global/firewallPolicies/{firewallPolicy}\n@desc Deletes the specified policy.\n@required {firewallPolicy: str # Name of the firewall policy to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /locations/global/firewallPolicies/{firewallPolicy}\n@desc Returns the specified firewall policy.\n@required {firewallPolicy: str # Name of the firewall policy to get.}\n@returns(200) {associations: [map], creationTimestamp: str, description: str, displayName: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, parent: str, region: str, ruleTupleCount: int(int32), rules: [map], selfLink: str, selfLinkWithId: str, shortName: str} # Successful response\n\n@endpoint PATCH /locations/global/firewallPolicies/{firewallPolicy}\n@desc Patches the specified policy with the data included in the request.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., associations: [map{attachmentTarget: str, displayName: str, firewallPolicyId: str, name: str, shortName: str}] # A list of associations that belong to this firewall policy., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., displayName: str # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., fingerprint: str(byte) # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#firewallPolicy # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies, name: str # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy., parent: str # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies., region: str # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., ruleTupleCount: int(int32) # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples., rules: [map{action: str, description: str, direction: str, disabled: bool, enableLogging: bool, kind: str, match: map, priority: int(int32), ruleName: str, ruleTupleCount: int(int32), targetResources: [str], targetSecureTags: [map], targetServiceAccounts: [str]}] # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match \"*\"). If no rules are provided when creating a firewall policy, a default rule with action \"allow\" will be added., selfLink: str # [Output Only] Server-defined URL for the resource., selfLinkWithId: str # [Output Only] Server-defined URL for this resource with the resource id., shortName: str # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /locations/global/firewallPolicies/{firewallPolicy}/addAssociation\n@desc Inserts an association for the specified firewall policy.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {replaceExistingAssociation: bool # Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., attachmentTarget: str # The target that the firewall policy is attached to., displayName: str # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association., firewallPolicyId: str # [Output Only] The firewall policy ID of the association., name: str # The name for an association., shortName: str # [Output Only] The short name of the firewall policy of the association.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /locations/global/firewallPolicies/{firewallPolicy}/addRule\n@desc Inserts a rule into a firewall policy.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., action: str # The Action to perform when the client connection triggers the rule. Valid actions are \"allow\", \"deny\" and \"goto_next\"., description: str # An optional description for this resource., direction: str(EGRESS/INGRESS) # The direction in which this rule applies., disabled: bool # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled., enableLogging: bool # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules., kind: str=compute#firewallPolicyRule # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules, match: map{destAddressGroups: [str], destFqdns: [str], destIpRanges: [str], destRegionCodes: [str], destThreatIntelligences: [str], layer4Configs: [map], srcAddressGroups: [str], srcFqdns: [str], srcIpRanges: [str], srcRegionCodes: [str], srcSecureTags: [map], srcThreatIntelligences: [str]} # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified., priority: int(int32) # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority., ruleName: str # An optional name for the rule. This field is not a unique identifier and can be updated., ruleTupleCount: int(int32) # [Output Only] Calculation of the complexity of a single firewall policy rule., targetResources: [str] # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule., targetSecureTags: [map{name: str, state: str}] # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256., targetServiceAccounts: [str] # A list of service accounts indicating the sets of instances that are applied with this rule.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /locations/global/firewallPolicies/{firewallPolicy}/cloneRules\n@desc Copies rules to the specified firewall policy.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sourceFirewallPolicy: str # The firewall policy from which to copy rules.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /locations/global/firewallPolicies/{firewallPolicy}/getAssociation\n@desc Gets an association with the specified name.\n@required {firewallPolicy: str # Name of the firewall policy to which the queried rule belongs.}\n@optional {name: str # The name of the association to get from the firewall policy.}\n@returns(200) {attachmentTarget: str, displayName: str, firewallPolicyId: str, name: str, shortName: str} # Successful response\n\n@endpoint GET /locations/global/firewallPolicies/{firewallPolicy}/getRule\n@desc Gets a rule of the specified priority.\n@required {firewallPolicy: str # Name of the firewall policy to which the queried rule belongs.}\n@optional {priority: int # The priority of the rule to get from the firewall policy.}\n@returns(200) {action: str, description: str, direction: str, disabled: bool, enableLogging: bool, kind: str, match: map{destAddressGroups: [str], destFqdns: [str], destIpRanges: [str], destRegionCodes: [str], destThreatIntelligences: [str], layer4Configs: [map], srcAddressGroups: [str], srcFqdns: [str], srcIpRanges: [str], srcRegionCodes: [str], srcSecureTags: [map], srcThreatIntelligences: [str]}, priority: int(int32), ruleName: str, ruleTupleCount: int(int32), targetResources: [str], targetSecureTags: [map], targetServiceAccounts: [str]} # Successful response\n\n@endpoint POST /locations/global/firewallPolicies/{firewallPolicy}/move\n@desc Moves the specified firewall policy.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {parentId: str # The new parent of the firewall policy. The ID can be either be \"folders/[FOLDER_ID]\" if the parent is a folder or \"organizations/[ORGANIZATION_ID]\" if the parent is an organization., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /locations/global/firewallPolicies/{firewallPolicy}/patchRule\n@desc Patches a rule of the specified priority.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {priority: int # The priority of the rule to patch., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., action: str # The Action to perform when the client connection triggers the rule. Valid actions are \"allow\", \"deny\" and \"goto_next\"., description: str # An optional description for this resource., direction: str(EGRESS/INGRESS) # The direction in which this rule applies., disabled: bool # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled., enableLogging: bool # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules., kind: str=compute#firewallPolicyRule # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules, match: map{destAddressGroups: [str], destFqdns: [str], destIpRanges: [str], destRegionCodes: [str], destThreatIntelligences: [str], layer4Configs: [map], srcAddressGroups: [str], srcFqdns: [str], srcIpRanges: [str], srcRegionCodes: [str], srcSecureTags: [map], srcThreatIntelligences: [str]} # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified., priority: int(int32) # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority., ruleName: str # An optional name for the rule. This field is not a unique identifier and can be updated., ruleTupleCount: int(int32) # [Output Only] Calculation of the complexity of a single firewall policy rule., targetResources: [str] # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule., targetSecureTags: [map{name: str, state: str}] # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256., targetServiceAccounts: [str] # A list of service accounts indicating the sets of instances that are applied with this rule.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /locations/global/firewallPolicies/{firewallPolicy}/removeAssociation\n@desc Removes an association for the specified firewall policy.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {name: str # Name for the attachment that will be removed., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /locations/global/firewallPolicies/{firewallPolicy}/removeRule\n@desc Deletes a rule of the specified priority.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {priority: int # The priority of the rule to remove from the firewall policy., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /locations/global/firewallPolicies/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /locations/global/firewallPolicies/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /locations/global/firewallPolicies/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /locations/global/operations\n@desc Retrieves a list of Operation resources contained within the specified organization.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., parentId: str # Parent ID for this request., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint DELETE /locations/global/operations/{operation}\n@desc Deletes the specified Operations resource.\n@required {operation: str # Name of the Operations resource to delete.}\n@optional {parentId: str # Parent ID for this request.}\n@returns(200) Successful response\n\n@endpoint GET /locations/global/operations/{operation}\n@desc Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request.\n@required {operation: str # Name of the Operations resource to return.}\n@optional {parentId: str # Parent ID for this request.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endgroup\n\n@group projects\n@endpoint GET /projects/{project}\n@desc Returns the specified Project resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.\n@returns(200) {commonInstanceMetadata: map{fingerprint: str(byte), items: [map], kind: str}, creationTimestamp: str, defaultNetworkTier: str, defaultServiceAccount: str, description: str, enabledFeatures: [str], id: str(uint64), kind: str, name: str, quotas: [map], selfLink: str, usageExportLocation: map{bucketName: str, reportNamePrefix: str}, vmDnsSetting: str, xpnProjectStatus: str} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/acceleratorTypes\n@desc Retrieves an aggregated list of accelerator types.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/addresses\n@desc Retrieves an aggregated list of addresses.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/autoscalers\n@desc Retrieves an aggregated list of autoscalers.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/backendServices\n@desc Retrieves the list of all BackendService resources, regional and global, available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/commitments\n@desc Retrieves an aggregated list of commitments by region.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/diskTypes\n@desc Retrieves an aggregated list of disk types.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/disks\n@desc Retrieves an aggregated list of persistent disks.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/forwardingRules\n@desc Retrieves an aggregated list of forwarding rules.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/healthChecks\n@desc Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/instanceGroupManagers\n@desc Retrieves the list of managed instance groups and groups them by zone.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/instanceGroups\n@desc Retrieves the list of instance groups and sorts them by zone.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/instanceTemplates\n@desc Retrieves the list of all InstanceTemplates resources, regional and global, available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/instances\n@desc Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/interconnectAttachments\n@desc Retrieves an aggregated list of interconnect attachments.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/machineTypes\n@desc Retrieves an aggregated list of machine types.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/networkAttachments\n@desc Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/networkEdgeSecurityServices\n@desc Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {etag: str, id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/networkEndpointGroups\n@desc Retrieves the list of network endpoint groups and sorts them by zone.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/nodeGroups\n@desc Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/nodeTemplates\n@desc Retrieves an aggregated list of node templates.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/nodeTypes\n@desc Retrieves an aggregated list of node types.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/operations\n@desc Retrieves an aggregated list of all operations.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/packetMirrorings\n@desc Retrieves an aggregated list of packetMirrorings.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/publicDelegatedPrefixes\n@desc Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/reservations\n@desc Retrieves an aggregated list of reservations.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/resourcePolicies\n@desc Retrieves an aggregated list of resource policies.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {etag: str, id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/routers\n@desc Retrieves an aggregated list of routers.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/securityPolicies\n@desc Retrieves the list of all SecurityPolicy resources, regional and global, available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {etag: str, id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/serviceAttachments\n@desc Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/sslCertificates\n@desc Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/sslPolicies\n@desc Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {etag: str, id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/subnetworks\n@desc Retrieves an aggregated list of subnetworks.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/subnetworks/listUsable\n@desc Retrieves an aggregated list of all usable subnetworks in the project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/targetHttpProxies\n@desc Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str]} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/targetHttpsProxies\n@desc Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/targetInstances\n@desc Retrieves an aggregated list of target instances.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/targetPools\n@desc Retrieves an aggregated list of target pools.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/targetTcpProxies\n@desc Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/targetVpnGateways\n@desc Retrieves an aggregated list of target VPN gateways.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/urlMaps\n@desc Retrieves the list of all UrlMap resources, regional and global, available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/vpnGateways\n@desc Retrieves an aggregated list of VPN gateways.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/aggregated/vpnTunnels\n@desc Retrieves an aggregated list of VPN tunnels.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., includeAllScopes: bool # Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: map, kind: str, nextPageToken: str, selfLink: str, unreachables: [str], warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/disableXpnHost\n@desc Disable this project as a shared VPC host project.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/disableXpnResource\n@desc Disable a service resource (also known as service project) associated with this host project.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., xpnResource: map{id: str, type: str} # Service resource (a.k.a service project) ID.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/enableXpnHost\n@desc Enable this project as a shared VPC host project.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/enableXpnResource\n@desc Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., xpnResource: map{id: str, type: str} # Service resource (a.k.a service project) ID.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/getXpnHost\n@desc Gets the shared VPC host project that this project links to. May be empty if no link exists.\n@returns(200) {commonInstanceMetadata: map{fingerprint: str(byte), items: [map], kind: str}, creationTimestamp: str, defaultNetworkTier: str, defaultServiceAccount: str, description: str, enabledFeatures: [str], id: str(uint64), kind: str, name: str, quotas: [map], selfLink: str, usageExportLocation: map{bucketName: str, reportNamePrefix: str}, vmDnsSetting: str, xpnProjectStatus: str} # Successful response\n\n@endpoint GET /projects/{project}/getXpnResources\n@desc Gets service resources (a.k.a service project) associated with this host project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {kind: str, nextPageToken: str, resources: [map]} # Successful response\n\n@endpoint GET /projects/{project}/global/addresses\n@desc Retrieves a list of global addresses.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/addresses\n@desc Creates an address resource in the specified project by using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., address: str # The static IP address represented by this resource., addressType: str(EXTERNAL/INTERNAL/UNSPECIFIED_TYPE) # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this field when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., ipVersion: str(IPV4/IPV6/UNSPECIFIED_VERSION) # The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address., ipv6EndpointType: str(NETLB/VM) # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation., kind: str=compute#address # [Output Only] Type of the resource. Always compute#address for addresses., name: str # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit., network: str # The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose., networkTier: str(FIXED_STANDARD/PREMIUM/STANDARD/STANDARD_OVERRIDES_FIXED_STANDARD) # This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM., prefixLength: int(int32) # The prefix length if the resource represents an IP range., purpose: str(DNS_RESOLVER/GCE_ENDPOINT/IPSEC_INTERCONNECT/NAT_AUTO/PRIVATE_SERVICE_CONNECT/SERVERLESS/SHARED_LOADBALANCER_VIP/VPC_PEERING) # The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose., region: str # [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.*, selfLink: str # [Output Only] Server-defined URL for the resource., status: str(IN_USE/RESERVED/RESERVING) # [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available., subnetwork: str # The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose., users: [str] # [Output Only] The URLs of the resources that are using this address.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/addresses/{address}\n@desc Deletes the specified address resource.\n@required {address: str # Name of the address resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/addresses/{address}\n@desc Returns the specified address resource.\n@required {address: str # Name of the address resource to return.}\n@returns(200) {address: str, addressType: str, creationTimestamp: str, description: str, id: str(uint64), ipVersion: str, ipv6EndpointType: str, kind: str, name: str, network: str, networkTier: str, prefixLength: int(int32), purpose: str, region: str, selfLink: str, status: str, subnetwork: str, users: [str]} # Successful response\n\n@endpoint POST /projects/{project}/global/addresses/{resource}/setLabels\n@desc Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint., labels: map # A list of labels to apply for this resource. Each label must comply with the requirements for labels. For example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\").}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/backendBuckets\n@desc Retrieves the list of BackendBucket resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/backendBuckets\n@desc Creates a BackendBucket resource in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., bucketName: str # Cloud Storage bucket name., cdnPolicy: map{bypassCacheOnRequestHeaders: [map], cacheKeyPolicy: map, cacheMode: str, clientTtl: int(int32), defaultTtl: int(int32), maxTtl: int(int32), negativeCaching: bool, negativeCachingPolicy: [map], requestCoalescing: bool, serveWhileStale: int(int32), signedUrlCacheMaxAgeSec: str(int64), signedUrlKeyNames: [str]} # Message containing Cloud CDN configuration for a backend bucket., compressionMode: str(AUTOMATIC/DISABLED) # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customResponseHeaders: [str] # Headers that the HTTP/S load balancer should add to proxied responses., description: str # An optional textual description of the resource; provided by the client when the resource is created., edgeSecurityPolicy: str # [Output Only] The resource URL for the edge security policy associated with this backend bucket., enableCdn: bool # If true, enable Cloud CDN for this BackendBucket., id: str(uint64) # [Output Only] Unique identifier for the resource; defined by the server., kind: str=compute#backendBucket # Type of the resource., name: str # 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., selfLink: str # [Output Only] Server-defined URL for the resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/backendBuckets/{backendBucket}\n@desc Deletes the specified BackendBucket resource.\n@required {backendBucket: str # Name of the BackendBucket resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/backendBuckets/{backendBucket}\n@desc Returns the specified BackendBucket resource.\n@required {backendBucket: str # Name of the BackendBucket resource to return.}\n@returns(200) {bucketName: str, cdnPolicy: map{bypassCacheOnRequestHeaders: [map], cacheKeyPolicy: map{includeHttpHeaders: [str], queryStringWhitelist: [str]}, cacheMode: str, clientTtl: int(int32), defaultTtl: int(int32), maxTtl: int(int32), negativeCaching: bool, negativeCachingPolicy: [map], requestCoalescing: bool, serveWhileStale: int(int32), signedUrlCacheMaxAgeSec: str(int64), signedUrlKeyNames: [str]}, compressionMode: str, creationTimestamp: str, customResponseHeaders: [str], description: str, edgeSecurityPolicy: str, enableCdn: bool, id: str(uint64), kind: str, name: str, selfLink: str} # Successful response\n\n@endpoint PATCH /projects/{project}/global/backendBuckets/{backendBucket}\n@desc Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {backendBucket: str # Name of the BackendBucket resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., bucketName: str # Cloud Storage bucket name., cdnPolicy: map{bypassCacheOnRequestHeaders: [map], cacheKeyPolicy: map, cacheMode: str, clientTtl: int(int32), defaultTtl: int(int32), maxTtl: int(int32), negativeCaching: bool, negativeCachingPolicy: [map], requestCoalescing: bool, serveWhileStale: int(int32), signedUrlCacheMaxAgeSec: str(int64), signedUrlKeyNames: [str]} # Message containing Cloud CDN configuration for a backend bucket., compressionMode: str(AUTOMATIC/DISABLED) # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customResponseHeaders: [str] # Headers that the HTTP/S load balancer should add to proxied responses., description: str # An optional textual description of the resource; provided by the client when the resource is created., edgeSecurityPolicy: str # [Output Only] The resource URL for the edge security policy associated with this backend bucket., enableCdn: bool # If true, enable Cloud CDN for this BackendBucket., id: str(uint64) # [Output Only] Unique identifier for the resource; defined by the server., kind: str=compute#backendBucket # Type of the resource., name: str # 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., selfLink: str # [Output Only] Server-defined URL for the resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/global/backendBuckets/{backendBucket}\n@desc Updates the specified BackendBucket resource with the data included in the request.\n@required {backendBucket: str # Name of the BackendBucket resource to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., bucketName: str # Cloud Storage bucket name., cdnPolicy: map{bypassCacheOnRequestHeaders: [map], cacheKeyPolicy: map, cacheMode: str, clientTtl: int(int32), defaultTtl: int(int32), maxTtl: int(int32), negativeCaching: bool, negativeCachingPolicy: [map], requestCoalescing: bool, serveWhileStale: int(int32), signedUrlCacheMaxAgeSec: str(int64), signedUrlKeyNames: [str]} # Message containing Cloud CDN configuration for a backend bucket., compressionMode: str(AUTOMATIC/DISABLED) # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customResponseHeaders: [str] # Headers that the HTTP/S load balancer should add to proxied responses., description: str # An optional textual description of the resource; provided by the client when the resource is created., edgeSecurityPolicy: str # [Output Only] The resource URL for the edge security policy associated with this backend bucket., enableCdn: bool # If true, enable Cloud CDN for this BackendBucket., id: str(uint64) # [Output Only] Unique identifier for the resource; defined by the server., kind: str=compute#backendBucket # Type of the resource., name: str # 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., selfLink: str # [Output Only] Server-defined URL for the resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey\n@desc Adds a key for validating requests with signed URLs for this backend bucket.\n@required {backendBucket: str # Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., keyName: str # Name of the key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., keyValue: str # 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey\n@desc Deletes a key for validating requests with signed URLs for this backend bucket.\n@required {backendBucket: str # Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035., keyName: str # The name of the Signed URL Key to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy\n@desc Sets the edge security policy for the specified backend bucket.\n@required {backendBucket: str # Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., securityPolicy: str}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/backendServices\n@desc Retrieves the list of BackendService resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/backendServices\n@desc Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview .\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., affinityCookieTtlSec: int(int32) # Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true., backends: [map{balancingMode: str, capacityScaler: num(float), description: str, failover: bool, group: str, maxConnections: int(int32), maxConnectionsPerEndpoint: int(int32), maxConnectionsPerInstance: int(int32), maxRate: int(int32), maxRatePerEndpoint: num(float), maxRatePerInstance: num(float), maxUtilization: num(float)}] # The list of backends that serve this BackendService., cdnPolicy: map{bypassCacheOnRequestHeaders: [map], cacheKeyPolicy: map, cacheMode: str, clientTtl: int(int32), defaultTtl: int(int32), maxTtl: int(int32), negativeCaching: bool, negativeCachingPolicy: [map], requestCoalescing: bool, serveWhileStale: int(int32), signedUrlCacheMaxAgeSec: str(int64), signedUrlKeyNames: [str]} # Message containing Cloud CDN configuration for a backend service., circuitBreakers: map{maxConnections: int(int32), maxPendingRequests: int(int32), maxRequests: int(int32), maxRequestsPerConnection: int(int32), maxRetries: int(int32)} # Settings controlling the volume of requests, connections and retries to this backend service., compressionMode: str(AUTOMATIC/DISABLED) # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header., connectionDraining: map{drainingTimeoutSec: int(int32)} # Message containing connection draining configuration., connectionTrackingPolicy: map{connectionPersistenceOnUnhealthyBackends: str, enableStrongAffinity: bool, idleTimeoutSec: int(int32), trackingMode: str} # Connection Tracking configuration for this BackendService., consistentHash: map{httpCookie: map, httpHeaderName: str, minimumRingSize: str(int64)} # This message defines settings for a consistent hash style load balancer., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customRequestHeaders: [str] # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)., customResponseHeaders: [str] # Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)., description: str # An optional description of this resource. Provide this property when you create the resource., edgeSecurityPolicy: str # [Output Only] The resource URL for the edge security policy associated with this backend service., enableCDN: bool # If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer., failoverPolicy: map{disableConnectionDrainOnFailover: bool, dropTrafficIfUnhealthy: bool, failoverRatio: num(float)} # For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes)., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService., healthChecks: [str] # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check., iap: map{enabled: bool, oauth2ClientId: str, oauth2ClientSecret: str, oauth2ClientSecretSha256: str} # Identity-Aware Proxy, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#backendService # [Output Only] Type of resource. Always compute#backendService for backend services., loadBalancingScheme: str(EXTERNAL/EXTERNAL_MANAGED/INTERNAL/INTERNAL_MANAGED/INTERNAL_SELF_MANAGED/INVALID_LOAD_BALANCING_SCHEME) # Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer., localityLbPolicies: [map{customPolicy: map, policy: map}] # A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration., localityLbPolicy: str(INVALID_LB_POLICY/LEAST_REQUEST/MAGLEV/ORIGINAL_DESTINATION/RANDOM/RING_HASH/ROUND_ROBIN/WEIGHTED_MAGLEV) # The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true., logConfig: map{enable: bool, optionalFields: [str], optionalMode: str, sampleRate: num(float)} # The available logging options for the load balancer traffic served by this backend service., maxStreamDuration: map{nanos: int(int32), seconds: str(int64)} # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". Range is approximately 10,000 years., name: str # 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., network: str # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL., outlierDetection: map{baseEjectionTime: map, consecutiveErrors: int(int32), consecutiveGatewayFailure: int(int32), enforcingConsecutiveErrors: int(int32), enforcingConsecutiveGatewayFailure: int(int32), enforcingSuccessRate: int(int32), interval: map, maxEjectionPercent: int(int32), successRateMinimumHosts: int(int32), successRateRequestVolume: int(int32), successRateStdevFactor: int(int32)} # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service., port: int(int32) # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port., portName: str # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name., protocol: str(GRPC/HTTP/HTTP2/HTTPS/SSL/TCP/UDP/UNSPECIFIED) # The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy., region: str # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., securityPolicy: str # [Output Only] The resource URL for the security policy associated with this backend service., securitySettings: map{clientTlsPolicy: str, subjectAltNames: [str]} # The authentication and authorization settings for a BackendService., selfLink: str # [Output Only] Server-defined URL for the resource., serviceBindings: [str] # URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty., sessionAffinity: str(CLIENT_IP/CLIENT_IP_NO_DESTINATION/CLIENT_IP_PORT_PROTO/CLIENT_IP_PROTO/GENERATED_COOKIE/HEADER_FIELD/HTTP_COOKIE/NONE) # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity)., subsetting: map{policy: str} # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director., timeoutSec: int(int32) # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/backendServices/{backendService}\n@desc Deletes the specified BackendService resource.\n@required {backendService: str # Name of the BackendService resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/backendServices/{backendService}\n@desc Returns the specified BackendService resource.\n@required {backendService: str # Name of the BackendService resource to return.}\n@returns(200) {affinityCookieTtlSec: int(int32), backends: [map], cdnPolicy: map{bypassCacheOnRequestHeaders: [map], cacheKeyPolicy: map{includeHost: bool, includeHttpHeaders: [str], includeNamedCookies: [str], includeProtocol: bool, includeQueryString: bool, queryStringBlacklist: [str], queryStringWhitelist: [str]}, cacheMode: str, clientTtl: int(int32), defaultTtl: int(int32), maxTtl: int(int32), negativeCaching: bool, negativeCachingPolicy: [map], requestCoalescing: bool, serveWhileStale: int(int32), signedUrlCacheMaxAgeSec: str(int64), signedUrlKeyNames: [str]}, circuitBreakers: map{maxConnections: int(int32), maxPendingRequests: int(int32), maxRequests: int(int32), maxRequestsPerConnection: int(int32), maxRetries: int(int32)}, compressionMode: str, connectionDraining: map{drainingTimeoutSec: int(int32)}, connectionTrackingPolicy: map{connectionPersistenceOnUnhealthyBackends: str, enableStrongAffinity: bool, idleTimeoutSec: int(int32), trackingMode: str}, consistentHash: map{httpCookie: map{name: str, path: str, ttl: map{nanos: int(int32), seconds: str(int64)}}, httpHeaderName: str, minimumRingSize: str(int64)}, creationTimestamp: str, customRequestHeaders: [str], customResponseHeaders: [str], description: str, edgeSecurityPolicy: str, enableCDN: bool, failoverPolicy: map{disableConnectionDrainOnFailover: bool, dropTrafficIfUnhealthy: bool, failoverRatio: num(float)}, fingerprint: str(byte), healthChecks: [str], iap: map{enabled: bool, oauth2ClientId: str, oauth2ClientSecret: str, oauth2ClientSecretSha256: str}, id: str(uint64), kind: str, loadBalancingScheme: str, localityLbPolicies: [map], localityLbPolicy: str, logConfig: map{enable: bool, optionalFields: [str], optionalMode: str, sampleRate: num(float)}, maxStreamDuration: map{nanos: int(int32), seconds: str(int64)}, name: str, network: str, outlierDetection: map{baseEjectionTime: map{nanos: int(int32), seconds: str(int64)}, consecutiveErrors: int(int32), consecutiveGatewayFailure: int(int32), enforcingConsecutiveErrors: int(int32), enforcingConsecutiveGatewayFailure: int(int32), enforcingSuccessRate: int(int32), interval: map{nanos: int(int32), seconds: str(int64)}, maxEjectionPercent: int(int32), successRateMinimumHosts: int(int32), successRateRequestVolume: int(int32), successRateStdevFactor: int(int32)}, port: int(int32), portName: str, protocol: str, region: str, securityPolicy: str, securitySettings: map{clientTlsPolicy: str, subjectAltNames: [str]}, selfLink: str, serviceBindings: [str], sessionAffinity: str, subsetting: map{policy: str}, timeoutSec: int(int32)} # Successful response\n\n@endpoint PATCH /projects/{project}/global/backendServices/{backendService}\n@desc Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {backendService: str # Name of the BackendService resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., affinityCookieTtlSec: int(int32) # Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true., backends: [map{balancingMode: str, capacityScaler: num(float), description: str, failover: bool, group: str, maxConnections: int(int32), maxConnectionsPerEndpoint: int(int32), maxConnectionsPerInstance: int(int32), maxRate: int(int32), maxRatePerEndpoint: num(float), maxRatePerInstance: num(float), maxUtilization: num(float)}] # The list of backends that serve this BackendService., cdnPolicy: map{bypassCacheOnRequestHeaders: [map], cacheKeyPolicy: map, cacheMode: str, clientTtl: int(int32), defaultTtl: int(int32), maxTtl: int(int32), negativeCaching: bool, negativeCachingPolicy: [map], requestCoalescing: bool, serveWhileStale: int(int32), signedUrlCacheMaxAgeSec: str(int64), signedUrlKeyNames: [str]} # Message containing Cloud CDN configuration for a backend service., circuitBreakers: map{maxConnections: int(int32), maxPendingRequests: int(int32), maxRequests: int(int32), maxRequestsPerConnection: int(int32), maxRetries: int(int32)} # Settings controlling the volume of requests, connections and retries to this backend service., compressionMode: str(AUTOMATIC/DISABLED) # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header., connectionDraining: map{drainingTimeoutSec: int(int32)} # Message containing connection draining configuration., connectionTrackingPolicy: map{connectionPersistenceOnUnhealthyBackends: str, enableStrongAffinity: bool, idleTimeoutSec: int(int32), trackingMode: str} # Connection Tracking configuration for this BackendService., consistentHash: map{httpCookie: map, httpHeaderName: str, minimumRingSize: str(int64)} # This message defines settings for a consistent hash style load balancer., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customRequestHeaders: [str] # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)., customResponseHeaders: [str] # Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)., description: str # An optional description of this resource. Provide this property when you create the resource., edgeSecurityPolicy: str # [Output Only] The resource URL for the edge security policy associated with this backend service., enableCDN: bool # If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer., failoverPolicy: map{disableConnectionDrainOnFailover: bool, dropTrafficIfUnhealthy: bool, failoverRatio: num(float)} # For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes)., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService., healthChecks: [str] # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check., iap: map{enabled: bool, oauth2ClientId: str, oauth2ClientSecret: str, oauth2ClientSecretSha256: str} # Identity-Aware Proxy, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#backendService # [Output Only] Type of resource. Always compute#backendService for backend services., loadBalancingScheme: str(EXTERNAL/EXTERNAL_MANAGED/INTERNAL/INTERNAL_MANAGED/INTERNAL_SELF_MANAGED/INVALID_LOAD_BALANCING_SCHEME) # Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer., localityLbPolicies: [map{customPolicy: map, policy: map}] # A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration., localityLbPolicy: str(INVALID_LB_POLICY/LEAST_REQUEST/MAGLEV/ORIGINAL_DESTINATION/RANDOM/RING_HASH/ROUND_ROBIN/WEIGHTED_MAGLEV) # The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true., logConfig: map{enable: bool, optionalFields: [str], optionalMode: str, sampleRate: num(float)} # The available logging options for the load balancer traffic served by this backend service., maxStreamDuration: map{nanos: int(int32), seconds: str(int64)} # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". Range is approximately 10,000 years., name: str # 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., network: str # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL., outlierDetection: map{baseEjectionTime: map, consecutiveErrors: int(int32), consecutiveGatewayFailure: int(int32), enforcingConsecutiveErrors: int(int32), enforcingConsecutiveGatewayFailure: int(int32), enforcingSuccessRate: int(int32), interval: map, maxEjectionPercent: int(int32), successRateMinimumHosts: int(int32), successRateRequestVolume: int(int32), successRateStdevFactor: int(int32)} # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service., port: int(int32) # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port., portName: str # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name., protocol: str(GRPC/HTTP/HTTP2/HTTPS/SSL/TCP/UDP/UNSPECIFIED) # The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy., region: str # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., securityPolicy: str # [Output Only] The resource URL for the security policy associated with this backend service., securitySettings: map{clientTlsPolicy: str, subjectAltNames: [str]} # The authentication and authorization settings for a BackendService., selfLink: str # [Output Only] Server-defined URL for the resource., serviceBindings: [str] # URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty., sessionAffinity: str(CLIENT_IP/CLIENT_IP_NO_DESTINATION/CLIENT_IP_PORT_PROTO/CLIENT_IP_PROTO/GENERATED_COOKIE/HEADER_FIELD/HTTP_COOKIE/NONE) # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity)., subsetting: map{policy: str} # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director., timeoutSec: int(int32) # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/global/backendServices/{backendService}\n@desc Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview.\n@required {backendService: str # Name of the BackendService resource to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., affinityCookieTtlSec: int(int32) # Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true., backends: [map{balancingMode: str, capacityScaler: num(float), description: str, failover: bool, group: str, maxConnections: int(int32), maxConnectionsPerEndpoint: int(int32), maxConnectionsPerInstance: int(int32), maxRate: int(int32), maxRatePerEndpoint: num(float), maxRatePerInstance: num(float), maxUtilization: num(float)}] # The list of backends that serve this BackendService., cdnPolicy: map{bypassCacheOnRequestHeaders: [map], cacheKeyPolicy: map, cacheMode: str, clientTtl: int(int32), defaultTtl: int(int32), maxTtl: int(int32), negativeCaching: bool, negativeCachingPolicy: [map], requestCoalescing: bool, serveWhileStale: int(int32), signedUrlCacheMaxAgeSec: str(int64), signedUrlKeyNames: [str]} # Message containing Cloud CDN configuration for a backend service., circuitBreakers: map{maxConnections: int(int32), maxPendingRequests: int(int32), maxRequests: int(int32), maxRequestsPerConnection: int(int32), maxRetries: int(int32)} # Settings controlling the volume of requests, connections and retries to this backend service., compressionMode: str(AUTOMATIC/DISABLED) # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header., connectionDraining: map{drainingTimeoutSec: int(int32)} # Message containing connection draining configuration., connectionTrackingPolicy: map{connectionPersistenceOnUnhealthyBackends: str, enableStrongAffinity: bool, idleTimeoutSec: int(int32), trackingMode: str} # Connection Tracking configuration for this BackendService., consistentHash: map{httpCookie: map, httpHeaderName: str, minimumRingSize: str(int64)} # This message defines settings for a consistent hash style load balancer., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customRequestHeaders: [str] # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)., customResponseHeaders: [str] # Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)., description: str # An optional description of this resource. Provide this property when you create the resource., edgeSecurityPolicy: str # [Output Only] The resource URL for the edge security policy associated with this backend service., enableCDN: bool # If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer., failoverPolicy: map{disableConnectionDrainOnFailover: bool, dropTrafficIfUnhealthy: bool, failoverRatio: num(float)} # For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes)., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService., healthChecks: [str] # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check., iap: map{enabled: bool, oauth2ClientId: str, oauth2ClientSecret: str, oauth2ClientSecretSha256: str} # Identity-Aware Proxy, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#backendService # [Output Only] Type of resource. Always compute#backendService for backend services., loadBalancingScheme: str(EXTERNAL/EXTERNAL_MANAGED/INTERNAL/INTERNAL_MANAGED/INTERNAL_SELF_MANAGED/INVALID_LOAD_BALANCING_SCHEME) # Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer., localityLbPolicies: [map{customPolicy: map, policy: map}] # A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration., localityLbPolicy: str(INVALID_LB_POLICY/LEAST_REQUEST/MAGLEV/ORIGINAL_DESTINATION/RANDOM/RING_HASH/ROUND_ROBIN/WEIGHTED_MAGLEV) # The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true., logConfig: map{enable: bool, optionalFields: [str], optionalMode: str, sampleRate: num(float)} # The available logging options for the load balancer traffic served by this backend service., maxStreamDuration: map{nanos: int(int32), seconds: str(int64)} # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". Range is approximately 10,000 years., name: str # 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., network: str # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL., outlierDetection: map{baseEjectionTime: map, consecutiveErrors: int(int32), consecutiveGatewayFailure: int(int32), enforcingConsecutiveErrors: int(int32), enforcingConsecutiveGatewayFailure: int(int32), enforcingSuccessRate: int(int32), interval: map, maxEjectionPercent: int(int32), successRateMinimumHosts: int(int32), successRateRequestVolume: int(int32), successRateStdevFactor: int(int32)} # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service., port: int(int32) # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port., portName: str # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name., protocol: str(GRPC/HTTP/HTTP2/HTTPS/SSL/TCP/UDP/UNSPECIFIED) # The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy., region: str # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., securityPolicy: str # [Output Only] The resource URL for the security policy associated with this backend service., securitySettings: map{clientTlsPolicy: str, subjectAltNames: [str]} # The authentication and authorization settings for a BackendService., selfLink: str # [Output Only] Server-defined URL for the resource., serviceBindings: [str] # URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty., sessionAffinity: str(CLIENT_IP/CLIENT_IP_NO_DESTINATION/CLIENT_IP_PORT_PROTO/CLIENT_IP_PROTO/GENERATED_COOKIE/HEADER_FIELD/HTTP_COOKIE/NONE) # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity)., subsetting: map{policy: str} # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director., timeoutSec: int(int32) # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/backendServices/{backendService}/addSignedUrlKey\n@desc Adds a key for validating requests with signed URLs for this backend service.\n@required {backendService: str # Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., keyName: str # Name of the key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., keyValue: str # 128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey\n@desc Deletes a key for validating requests with signed URLs for this backend service.\n@required {backendService: str # Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035., keyName: str # The name of the Signed URL Key to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/backendServices/{backendService}/getHealth\n@desc Gets the most recent health check results for this BackendService. Example request body: { \"group\": \"/zones/us-east1-b/instanceGroups/lb-backend-example\" }\n@required {backendService: str # Name of the BackendService resource to which the queried instance belongs.}\n@optional {group: str # A URI referencing one of the instance groups or network endpoint groups listed in the backend service.}\n@returns(200) {annotations: map, healthStatus: [map], kind: str} # Successful response\n\n@endpoint POST /projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy\n@desc Sets the edge security policy for the specified backend service.\n@required {backendService: str # Name of the BackendService resource to which the edge security policy should be set. The name should conform to RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., securityPolicy: str}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/backendServices/{backendService}/setSecurityPolicy\n@desc Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview\n@required {backendService: str # Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., securityPolicy: str}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/backendServices/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/global/backendServices/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint GET /projects/{project}/global/externalVpnGateways\n@desc Retrieves the list of ExternalVpnGateway available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {etag: str, id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/externalVpnGateways\n@desc Creates a ExternalVpnGateway in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., interfaces: [map{id: int(uint32), ipAddress: str}] # A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway., kind: str=compute#externalVpnGateway # [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway., labels: map # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty., name: str # 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., redundancyType: str(FOUR_IPS_REDUNDANCY/SINGLE_IP_INTERNALLY_REDUNDANT/TWO_IPS_REDUNDANCY) # Indicates the user-supplied redundancy type of this external VPN gateway., selfLink: str # [Output Only] Server-defined URL for the resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/externalVpnGateways/{externalVpnGateway}\n@desc Deletes the specified externalVpnGateway.\n@required {externalVpnGateway: str # Name of the externalVpnGateways to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/externalVpnGateways/{externalVpnGateway}\n@desc Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.\n@required {externalVpnGateway: str # Name of the externalVpnGateway to return.}\n@returns(200) {creationTimestamp: str, description: str, id: str(uint64), interfaces: [map], kind: str, labelFingerprint: str(byte), labels: map, name: str, redundancyType: str, selfLink: str} # Successful response\n\n@endpoint POST /projects/{project}/global/externalVpnGateways/{resource}/setLabels\n@desc Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint., labels: map # A list of labels to apply for this resource. Each label must comply with the requirements for labels. For example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\").}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/global/firewallPolicies\n@desc Lists all the policies that have been configured for the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/firewallPolicies\n@desc Creates a new policy in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., associations: [map{attachmentTarget: str, displayName: str, firewallPolicyId: str, name: str, shortName: str}] # A list of associations that belong to this firewall policy., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., displayName: str # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., fingerprint: str(byte) # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#firewallPolicy # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies, name: str # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy., parent: str # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies., region: str # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., ruleTupleCount: int(int32) # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples., rules: [map{action: str, description: str, direction: str, disabled: bool, enableLogging: bool, kind: str, match: map, priority: int(int32), ruleName: str, ruleTupleCount: int(int32), targetResources: [str], targetSecureTags: [map], targetServiceAccounts: [str]}] # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match \"*\"). If no rules are provided when creating a firewall policy, a default rule with action \"allow\" will be added., selfLink: str # [Output Only] Server-defined URL for the resource., selfLinkWithId: str # [Output Only] Server-defined URL for this resource with the resource id., shortName: str # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/firewallPolicies/{firewallPolicy}\n@desc Deletes the specified policy.\n@required {firewallPolicy: str # Name of the firewall policy to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/firewallPolicies/{firewallPolicy}\n@desc Returns the specified network firewall policy.\n@required {firewallPolicy: str # Name of the firewall policy to get.}\n@returns(200) {associations: [map], creationTimestamp: str, description: str, displayName: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, parent: str, region: str, ruleTupleCount: int(int32), rules: [map], selfLink: str, selfLinkWithId: str, shortName: str} # Successful response\n\n@endpoint PATCH /projects/{project}/global/firewallPolicies/{firewallPolicy}\n@desc Patches the specified policy with the data included in the request.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., associations: [map{attachmentTarget: str, displayName: str, firewallPolicyId: str, name: str, shortName: str}] # A list of associations that belong to this firewall policy., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., displayName: str # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., fingerprint: str(byte) # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#firewallPolicy # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies, name: str # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy., parent: str # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies., region: str # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., ruleTupleCount: int(int32) # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples., rules: [map{action: str, description: str, direction: str, disabled: bool, enableLogging: bool, kind: str, match: map, priority: int(int32), ruleName: str, ruleTupleCount: int(int32), targetResources: [str], targetSecureTags: [map], targetServiceAccounts: [str]}] # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match \"*\"). If no rules are provided when creating a firewall policy, a default rule with action \"allow\" will be added., selfLink: str # [Output Only] Server-defined URL for the resource., selfLinkWithId: str # [Output Only] Server-defined URL for this resource with the resource id., shortName: str # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation\n@desc Inserts an association for the specified firewall policy.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {replaceExistingAssociation: bool # Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., attachmentTarget: str # The target that the firewall policy is attached to., displayName: str # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association., firewallPolicyId: str # [Output Only] The firewall policy ID of the association., name: str # The name for an association., shortName: str # [Output Only] The short name of the firewall policy of the association.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule\n@desc Inserts a rule into a firewall policy.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {maxPriority: int # When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority., minPriority: int # When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., action: str # The Action to perform when the client connection triggers the rule. Valid actions are \"allow\", \"deny\" and \"goto_next\"., description: str # An optional description for this resource., direction: str(EGRESS/INGRESS) # The direction in which this rule applies., disabled: bool # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled., enableLogging: bool # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules., kind: str=compute#firewallPolicyRule # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules, match: map{destAddressGroups: [str], destFqdns: [str], destIpRanges: [str], destRegionCodes: [str], destThreatIntelligences: [str], layer4Configs: [map], srcAddressGroups: [str], srcFqdns: [str], srcIpRanges: [str], srcRegionCodes: [str], srcSecureTags: [map], srcThreatIntelligences: [str]} # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified., priority: int(int32) # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority., ruleName: str # An optional name for the rule. This field is not a unique identifier and can be updated., ruleTupleCount: int(int32) # [Output Only] Calculation of the complexity of a single firewall policy rule., targetResources: [str] # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule., targetSecureTags: [map{name: str, state: str}] # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256., targetServiceAccounts: [str] # A list of service accounts indicating the sets of instances that are applied with this rule.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules\n@desc Copies rules to the specified firewall policy.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sourceFirewallPolicy: str # The firewall policy from which to copy rules.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation\n@desc Gets an association with the specified name.\n@required {firewallPolicy: str # Name of the firewall policy to which the queried association belongs.}\n@optional {name: str # The name of the association to get from the firewall policy.}\n@returns(200) {attachmentTarget: str, displayName: str, firewallPolicyId: str, name: str, shortName: str} # Successful response\n\n@endpoint GET /projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule\n@desc Gets a rule of the specified priority.\n@required {firewallPolicy: str # Name of the firewall policy to which the queried rule belongs.}\n@optional {priority: int # The priority of the rule to get from the firewall policy.}\n@returns(200) {action: str, description: str, direction: str, disabled: bool, enableLogging: bool, kind: str, match: map{destAddressGroups: [str], destFqdns: [str], destIpRanges: [str], destRegionCodes: [str], destThreatIntelligences: [str], layer4Configs: [map], srcAddressGroups: [str], srcFqdns: [str], srcIpRanges: [str], srcRegionCodes: [str], srcSecureTags: [map], srcThreatIntelligences: [str]}, priority: int(int32), ruleName: str, ruleTupleCount: int(int32), targetResources: [str], targetSecureTags: [map], targetServiceAccounts: [str]} # Successful response\n\n@endpoint POST /projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule\n@desc Patches a rule of the specified priority.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {priority: int # The priority of the rule to patch., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., action: str # The Action to perform when the client connection triggers the rule. Valid actions are \"allow\", \"deny\" and \"goto_next\"., description: str # An optional description for this resource., direction: str(EGRESS/INGRESS) # The direction in which this rule applies., disabled: bool # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled., enableLogging: bool # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules., kind: str=compute#firewallPolicyRule # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules, match: map{destAddressGroups: [str], destFqdns: [str], destIpRanges: [str], destRegionCodes: [str], destThreatIntelligences: [str], layer4Configs: [map], srcAddressGroups: [str], srcFqdns: [str], srcIpRanges: [str], srcRegionCodes: [str], srcSecureTags: [map], srcThreatIntelligences: [str]} # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified., priority: int(int32) # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority., ruleName: str # An optional name for the rule. This field is not a unique identifier and can be updated., ruleTupleCount: int(int32) # [Output Only] Calculation of the complexity of a single firewall policy rule., targetResources: [str] # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule., targetSecureTags: [map{name: str, state: str}] # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256., targetServiceAccounts: [str] # A list of service accounts indicating the sets of instances that are applied with this rule.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation\n@desc Removes an association for the specified firewall policy.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {name: str # Name for the attachment that will be removed., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule\n@desc Deletes a rule of the specified priority.\n@required {firewallPolicy: str # Name of the firewall policy to update.}\n@optional {priority: int # The priority of the rule to remove from the firewall policy., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/firewallPolicies/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/global/firewallPolicies/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/global/firewallPolicies/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/global/firewalls\n@desc Retrieves the list of firewall rules available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/firewalls\n@desc Creates a firewall rule in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., allowed: [map{IPProtocol: str, ports: [str]}] # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., denied: [map{IPProtocol: str, ports: [str]}] # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection., description: str # An optional description of this resource. Provide this field when you create the resource., destinationRanges: [str] # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported., direction: str(EGRESS/INGRESS) # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot specify the sourceTags fields., disabled: bool # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#firewall # [Output Only] Type of the resource. Always compute#firewall for firewall rules., logConfig: map{enable: bool, metadata: str} # The available logging options for a firewall rule., name: str # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit., network: str # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default, priority: int(int32) # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`., selfLink: str # [Output Only] Server-defined URL for the resource., sourceRanges: [str] # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported., sourceServiceAccounts: [str] # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags., sourceTags: [str] # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply., targetServiceAccounts: [str] # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network., targetTags: [str] # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/firewalls/{firewall}\n@desc Deletes the specified firewall.\n@required {firewall: str # Name of the firewall rule to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/firewalls/{firewall}\n@desc Returns the specified firewall.\n@required {firewall: str # Name of the firewall rule to return.}\n@returns(200) {allowed: [map], creationTimestamp: str, denied: [map], description: str, destinationRanges: [str], direction: str, disabled: bool, id: str(uint64), kind: str, logConfig: map{enable: bool, metadata: str}, name: str, network: str, priority: int(int32), selfLink: str, sourceRanges: [str], sourceServiceAccounts: [str], sourceTags: [str], targetServiceAccounts: [str], targetTags: [str]} # Successful response\n\n@endpoint PATCH /projects/{project}/global/firewalls/{firewall}\n@desc Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {firewall: str # Name of the firewall rule to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., allowed: [map{IPProtocol: str, ports: [str]}] # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., denied: [map{IPProtocol: str, ports: [str]}] # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection., description: str # An optional description of this resource. Provide this field when you create the resource., destinationRanges: [str] # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported., direction: str(EGRESS/INGRESS) # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot specify the sourceTags fields., disabled: bool # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#firewall # [Output Only] Type of the resource. Always compute#firewall for firewall rules., logConfig: map{enable: bool, metadata: str} # The available logging options for a firewall rule., name: str # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit., network: str # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default, priority: int(int32) # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`., selfLink: str # [Output Only] Server-defined URL for the resource., sourceRanges: [str] # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported., sourceServiceAccounts: [str] # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags., sourceTags: [str] # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply., targetServiceAccounts: [str] # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network., targetTags: [str] # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/global/firewalls/{firewall}\n@desc Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.\n@required {firewall: str # Name of the firewall rule to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., allowed: [map{IPProtocol: str, ports: [str]}] # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., denied: [map{IPProtocol: str, ports: [str]}] # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection., description: str # An optional description of this resource. Provide this field when you create the resource., destinationRanges: [str] # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported., direction: str(EGRESS/INGRESS) # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot specify the sourceTags fields., disabled: bool # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#firewall # [Output Only] Type of the resource. Always compute#firewall for firewall rules., logConfig: map{enable: bool, metadata: str} # The available logging options for a firewall rule., name: str # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit., network: str # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default, priority: int(int32) # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`., selfLink: str # [Output Only] Server-defined URL for the resource., sourceRanges: [str] # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported., sourceServiceAccounts: [str] # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags., sourceTags: [str] # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply., targetServiceAccounts: [str] # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network., targetTags: [str] # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/forwardingRules\n@desc Retrieves a list of GlobalForwardingRule resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/forwardingRules\n@desc Creates a GlobalForwardingRule resource in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., IPAddress: str # IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number., IPProtocol: str(AH/ESP/ICMP/L3_DEFAULT/SCTP/TCP/UDP) # The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends)., allPorts: bool # This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive., allowGlobalAccess: bool # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer., allowPscGlobalAccess: bool # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region., backendService: str # Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types., baseForwardingRule: str # [Output Only] The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., ipVersion: str(IPV4/IPV6/UNSPECIFIED_VERSION) # The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6., isMirroringCollector: bool # Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL., kind: str=compute#forwardingRule # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule., labels: map # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty., loadBalancingScheme: str(EXTERNAL/EXTERNAL_MANAGED/INTERNAL/INTERNAL_MANAGED/INTERNAL_SELF_MANAGED/INVALID) # Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts., metadataFilters: [map{filterLabels: [map], filterMatchCriteria: str}] # Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED., name: str # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter., network: str # This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided., networkTier: str(FIXED_STANDARD/PREMIUM/STANDARD/STANDARD_OVERRIDES_FIXED_STANDARD) # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address., noAutomateDnsZone: bool # This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field., portRange: str # This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\\\d+(?:-\\\\d+)?, ports: [str] # This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\\\d+(?:-\\\\d+)?, pscConnectionId: str(uint64) # [Output Only] The PSC connection id of the PSC Forwarding Rule., pscConnectionStatus: str(ACCEPTED/CLOSED/NEEDS_ATTENTION/PENDING/REJECTED/STATUS_UNSPECIFIED), region: str # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., serviceDirectoryRegistrations: [map{namespace: str, service: str, serviceDirectoryRegion: str}] # Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource., serviceLabel: str # An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing., serviceName: str # [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing., sourceIpRanges: [str] # If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24)., subnetwork: str # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6., target: str # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the \"Target\" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/forwardingRules/{forwardingRule}\n@desc Deletes the specified GlobalForwardingRule resource.\n@required {forwardingRule: str # Name of the ForwardingRule resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/forwardingRules/{forwardingRule}\n@desc Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.\n@required {forwardingRule: str # Name of the ForwardingRule resource to return.}\n@returns(200) {IPAddress: str, IPProtocol: str, allPorts: bool, allowGlobalAccess: bool, allowPscGlobalAccess: bool, backendService: str, baseForwardingRule: str, creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), ipVersion: str, isMirroringCollector: bool, kind: str, labelFingerprint: str(byte), labels: map, loadBalancingScheme: str, metadataFilters: [map], name: str, network: str, networkTier: str, noAutomateDnsZone: bool, portRange: str, ports: [str], pscConnectionId: str(uint64), pscConnectionStatus: str, region: str, selfLink: str, serviceDirectoryRegistrations: [map], serviceLabel: str, serviceName: str, sourceIpRanges: [str], subnetwork: str, target: str} # Successful response\n\n@endpoint PATCH /projects/{project}/global/forwardingRules/{forwardingRule}\n@desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.\n@required {forwardingRule: str # Name of the ForwardingRule resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., IPAddress: str # IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number., IPProtocol: str(AH/ESP/ICMP/L3_DEFAULT/SCTP/TCP/UDP) # The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends)., allPorts: bool # This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive., allowGlobalAccess: bool # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer., allowPscGlobalAccess: bool # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region., backendService: str # Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types., baseForwardingRule: str # [Output Only] The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., ipVersion: str(IPV4/IPV6/UNSPECIFIED_VERSION) # The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6., isMirroringCollector: bool # Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL., kind: str=compute#forwardingRule # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule., labels: map # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty., loadBalancingScheme: str(EXTERNAL/EXTERNAL_MANAGED/INTERNAL/INTERNAL_MANAGED/INTERNAL_SELF_MANAGED/INVALID) # Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts., metadataFilters: [map{filterLabels: [map], filterMatchCriteria: str}] # Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED., name: str # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter., network: str # This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided., networkTier: str(FIXED_STANDARD/PREMIUM/STANDARD/STANDARD_OVERRIDES_FIXED_STANDARD) # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address., noAutomateDnsZone: bool # This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field., portRange: str # This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\\\d+(?:-\\\\d+)?, ports: [str] # This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\\\d+(?:-\\\\d+)?, pscConnectionId: str(uint64) # [Output Only] The PSC connection id of the PSC Forwarding Rule., pscConnectionStatus: str(ACCEPTED/CLOSED/NEEDS_ATTENTION/PENDING/REJECTED/STATUS_UNSPECIFIED), region: str # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., serviceDirectoryRegistrations: [map{namespace: str, service: str, serviceDirectoryRegion: str}] # Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource., serviceLabel: str # An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing., serviceName: str # [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing., sourceIpRanges: [str] # If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24)., subnetwork: str # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6., target: str # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the \"Target\" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/forwardingRules/{forwardingRule}/setTarget\n@desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.\n@required {forwardingRule: str # Name of the ForwardingRule resource in which target is to be set.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., target: str}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/forwardingRules/{resource}/setLabels\n@desc Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint., labels: map # A list of labels to apply for this resource. Each label must comply with the requirements for labels. For example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\").}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/healthChecks\n@desc Retrieves the list of HealthCheck resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/healthChecks\n@desc Creates a HealthCheck resource in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., checkIntervalSec: int(int32) # How often (in seconds) to send a health check. The default value is 5 seconds., creationTimestamp: str # [Output Only] Creation timestamp in 3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., grpcHealthCheck: map{grpcServiceName: str, port: int(int32), portName: str, portSpecification: str}, healthyThreshold: int(int32) # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2., http2HealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpsHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#healthCheck # Type of the resource., logConfig: map{enable: bool} # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver., name: str # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash., region: str # [Output Only] Region where the health check resides. Not applicable to global health checks., selfLink: str # [Output Only] Server-defined URL for the resource., sslHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, tcpHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, timeoutSec: int(int32) # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec., type: str(GRPC/HTTP/HTTP2/HTTPS/INVALID/SSL/TCP) # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field., unhealthyThreshold: int(int32) # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/healthChecks/{healthCheck}\n@desc Deletes the specified HealthCheck resource.\n@required {healthCheck: str # Name of the HealthCheck resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/healthChecks/{healthCheck}\n@desc Returns the specified HealthCheck resource.\n@required {healthCheck: str # Name of the HealthCheck resource to return.}\n@returns(200) {checkIntervalSec: int(int32), creationTimestamp: str, description: str, grpcHealthCheck: map{grpcServiceName: str, port: int(int32), portName: str, portSpecification: str}, healthyThreshold: int(int32), http2HealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpsHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, id: str(uint64), kind: str, logConfig: map{enable: bool}, name: str, region: str, selfLink: str, sslHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, tcpHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, timeoutSec: int(int32), type: str, unhealthyThreshold: int(int32)} # Successful response\n\n@endpoint PATCH /projects/{project}/global/healthChecks/{healthCheck}\n@desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {healthCheck: str # Name of the HealthCheck resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., checkIntervalSec: int(int32) # How often (in seconds) to send a health check. The default value is 5 seconds., creationTimestamp: str # [Output Only] Creation timestamp in 3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., grpcHealthCheck: map{grpcServiceName: str, port: int(int32), portName: str, portSpecification: str}, healthyThreshold: int(int32) # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2., http2HealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpsHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#healthCheck # Type of the resource., logConfig: map{enable: bool} # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver., name: str # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash., region: str # [Output Only] Region where the health check resides. Not applicable to global health checks., selfLink: str # [Output Only] Server-defined URL for the resource., sslHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, tcpHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, timeoutSec: int(int32) # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec., type: str(GRPC/HTTP/HTTP2/HTTPS/INVALID/SSL/TCP) # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field., unhealthyThreshold: int(int32) # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/global/healthChecks/{healthCheck}\n@desc Updates a HealthCheck resource in the specified project using the data included in the request.\n@required {healthCheck: str # Name of the HealthCheck resource to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., checkIntervalSec: int(int32) # How often (in seconds) to send a health check. The default value is 5 seconds., creationTimestamp: str # [Output Only] Creation timestamp in 3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., grpcHealthCheck: map{grpcServiceName: str, port: int(int32), portName: str, portSpecification: str}, healthyThreshold: int(int32) # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2., http2HealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpsHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#healthCheck # Type of the resource., logConfig: map{enable: bool} # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver., name: str # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash., region: str # [Output Only] Region where the health check resides. Not applicable to global health checks., selfLink: str # [Output Only] Server-defined URL for the resource., sslHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, tcpHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, timeoutSec: int(int32) # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec., type: str(GRPC/HTTP/HTTP2/HTTPS/INVALID/SSL/TCP) # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field., unhealthyThreshold: int(int32) # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/httpHealthChecks\n@desc Retrieves the list of HttpHealthCheck resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/httpHealthChecks\n@desc Creates a HttpHealthCheck resource in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., checkIntervalSec: int(int32) # How often (in seconds) to send a health check. The default value is 5 seconds., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., healthyThreshold: int(int32) # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2., host: str # 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: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#httpHealthCheck # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks., name: str # 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., port: int(int32) # The TCP port number for the HTTP health check request. The default value is 80., requestPath: str # The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986., selfLink: str # [Output Only] Server-defined URL for the resource., timeoutSec: int(int32) # 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., unhealthyThreshold: int(int32) # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/httpHealthChecks/{httpHealthCheck}\n@desc Deletes the specified HttpHealthCheck resource.\n@required {httpHealthCheck: str # Name of the HttpHealthCheck resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/httpHealthChecks/{httpHealthCheck}\n@desc Returns the specified HttpHealthCheck resource.\n@required {httpHealthCheck: str # Name of the HttpHealthCheck resource to return.}\n@returns(200) {checkIntervalSec: int(int32), creationTimestamp: str, description: str, healthyThreshold: int(int32), host: str, id: str(uint64), kind: str, name: str, port: int(int32), requestPath: str, selfLink: str, timeoutSec: int(int32), unhealthyThreshold: int(int32)} # Successful response\n\n@endpoint PATCH /projects/{project}/global/httpHealthChecks/{httpHealthCheck}\n@desc Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {httpHealthCheck: str # Name of the HttpHealthCheck resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., checkIntervalSec: int(int32) # How often (in seconds) to send a health check. The default value is 5 seconds., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., healthyThreshold: int(int32) # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2., host: str # 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: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#httpHealthCheck # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks., name: str # 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., port: int(int32) # The TCP port number for the HTTP health check request. The default value is 80., requestPath: str # The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986., selfLink: str # [Output Only] Server-defined URL for the resource., timeoutSec: int(int32) # 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., unhealthyThreshold: int(int32) # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/global/httpHealthChecks/{httpHealthCheck}\n@desc Updates a HttpHealthCheck resource in the specified project using the data included in the request.\n@required {httpHealthCheck: str # Name of the HttpHealthCheck resource to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., checkIntervalSec: int(int32) # How often (in seconds) to send a health check. The default value is 5 seconds., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., healthyThreshold: int(int32) # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2., host: str # 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: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#httpHealthCheck # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks., name: str # 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., port: int(int32) # The TCP port number for the HTTP health check request. The default value is 80., requestPath: str # The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986., selfLink: str # [Output Only] Server-defined URL for the resource., timeoutSec: int(int32) # 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., unhealthyThreshold: int(int32) # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/httpsHealthChecks\n@desc Retrieves the list of HttpsHealthCheck resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/httpsHealthChecks\n@desc Creates a HttpsHealthCheck resource in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., checkIntervalSec: int(int32) # How often (in seconds) to send a health check. The default value is 5 seconds., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., healthyThreshold: int(int32) # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2., host: str # 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: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#httpsHealthCheck # Type of the resource., name: str # 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., port: int(int32) # The TCP port number for the HTTPS health check request. The default value is 443., requestPath: str # The request path of the HTTPS health check request. The default value is \"/\". Must comply with RFC3986., selfLink: str # [Output Only] Server-defined URL for the resource., timeoutSec: int(int32) # 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., unhealthyThreshold: int(int32) # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}\n@desc Deletes the specified HttpsHealthCheck resource.\n@required {httpsHealthCheck: str # Name of the HttpsHealthCheck resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}\n@desc Returns the specified HttpsHealthCheck resource.\n@required {httpsHealthCheck: str # Name of the HttpsHealthCheck resource to return.}\n@returns(200) {checkIntervalSec: int(int32), creationTimestamp: str, description: str, healthyThreshold: int(int32), host: str, id: str(uint64), kind: str, name: str, port: int(int32), requestPath: str, selfLink: str, timeoutSec: int(int32), unhealthyThreshold: int(int32)} # Successful response\n\n@endpoint PATCH /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}\n@desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {httpsHealthCheck: str # Name of the HttpsHealthCheck resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., checkIntervalSec: int(int32) # How often (in seconds) to send a health check. The default value is 5 seconds., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., healthyThreshold: int(int32) # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2., host: str # 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: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#httpsHealthCheck # Type of the resource., name: str # 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., port: int(int32) # The TCP port number for the HTTPS health check request. The default value is 443., requestPath: str # The request path of the HTTPS health check request. The default value is \"/\". Must comply with RFC3986., selfLink: str # [Output Only] Server-defined URL for the resource., timeoutSec: int(int32) # 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., unhealthyThreshold: int(int32) # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}\n@desc Updates a HttpsHealthCheck resource in the specified project using the data included in the request.\n@required {httpsHealthCheck: str # Name of the HttpsHealthCheck resource to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., checkIntervalSec: int(int32) # How often (in seconds) to send a health check. The default value is 5 seconds., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., healthyThreshold: int(int32) # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2., host: str # 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: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#httpsHealthCheck # Type of the resource., name: str # 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., port: int(int32) # The TCP port number for the HTTPS health check request. The default value is 443., requestPath: str # The request path of the HTTPS health check request. The default value is \"/\". Must comply with RFC3986., selfLink: str # [Output Only] Server-defined URL for the resource., timeoutSec: int(int32) # 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., unhealthyThreshold: int(int32) # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/images\n@desc Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/images\n@desc Creates an image in the specified project using the data included in the request.\n@optional {forceCreate: bool # Force image creation if true., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., architecture: str(ARCHITECTURE_UNSPECIFIED/ARM64/X86_64) # The architecture of the image. Valid values are ARM64 or X86_64., archiveSizeBytes: str(int64) # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., deprecated: map{deleted: str, deprecated: str, obsolete: str, replacement: str, state: str} # Deprecation status for a public resource., description: str # An optional description of this resource. Provide this property when you create the resource., diskSizeGb: str(int64) # Size of the image when restored onto a persistent disk (in GB)., family: str # The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035., guestOsFeatures: [map{type: str}] # A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., imageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, kind: str=compute#image # [Output Only] Type of the resource. Always compute#image for images., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image., labels: map # Labels to apply to this image. These can be later modified by the setLabels method., licenseCodes: [str(int64)] # Integer license codes indicating which licenses are attached to this image., licenses: [str] # Any applicable license URI., name: str # 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., rawDisk: map{containerType: str, sha1Checksum: str, source: str} # The parameters of the raw disk image., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined URL for the resource., shieldedInstanceInitialState: map{dbs: [map], dbxs: [map], keks: [map], pk: map} # Initial State for shielded instance, these are public keys which are safe to store in public, sourceDisk: str # URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL, sourceDiskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceDiskId: str # [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name., sourceImage: str # URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL, sourceImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceImageId: str # [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name., sourceSnapshot: str # URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL, sourceSnapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceSnapshotId: str # [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name., sourceType: str=RAW # The type of the image used to create this disk. The default and only valid value is RAW., status: str(DELETING/FAILED/PENDING/READY) # [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., storageLocations: [str] # Cloud Storage bucket storage location of the image (regional or multi-regional).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/images/family/{family}\n@desc Returns the latest image that is part of an image family and is not deprecated. For more information on image families, see Public image families documentation.\n@required {family: str # Name of the image family to search for.}\n@returns(200) {architecture: str, archiveSizeBytes: str(int64), creationTimestamp: str, deprecated: map{deleted: str, deprecated: str, obsolete: str, replacement: str, state: str}, description: str, diskSizeGb: str(int64), family: str, guestOsFeatures: [map], id: str(uint64), imageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, kind: str, labelFingerprint: str(byte), labels: map, licenseCodes: [str(int64)], licenses: [str], name: str, rawDisk: map{containerType: str, sha1Checksum: str, source: str}, satisfiesPzs: bool, selfLink: str, shieldedInstanceInitialState: map{dbs: [map], dbxs: [map], keks: [map], pk: map{content: str(byte), fileType: str}}, sourceDisk: str, sourceDiskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceDiskId: str, sourceImage: str, sourceImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceImageId: str, sourceSnapshot: str, sourceSnapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceSnapshotId: str, sourceType: str, status: str, storageLocations: [str]} # Successful response\n\n@endpoint DELETE /projects/{project}/global/images/{image}\n@desc Deletes the specified image.\n@required {image: str # Name of the image resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/images/{image}\n@desc Returns the specified image.\n@required {image: str # Name of the image resource to return.}\n@returns(200) {architecture: str, archiveSizeBytes: str(int64), creationTimestamp: str, deprecated: map{deleted: str, deprecated: str, obsolete: str, replacement: str, state: str}, description: str, diskSizeGb: str(int64), family: str, guestOsFeatures: [map], id: str(uint64), imageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, kind: str, labelFingerprint: str(byte), labels: map, licenseCodes: [str(int64)], licenses: [str], name: str, rawDisk: map{containerType: str, sha1Checksum: str, source: str}, satisfiesPzs: bool, selfLink: str, shieldedInstanceInitialState: map{dbs: [map], dbxs: [map], keks: [map], pk: map{content: str(byte), fileType: str}}, sourceDisk: str, sourceDiskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceDiskId: str, sourceImage: str, sourceImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceImageId: str, sourceSnapshot: str, sourceSnapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceSnapshotId: str, sourceType: str, status: str, storageLocations: [str]} # Successful response\n\n@endpoint PATCH /projects/{project}/global/images/{image}\n@desc Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.\n@required {image: str # Name of the image resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., architecture: str(ARCHITECTURE_UNSPECIFIED/ARM64/X86_64) # The architecture of the image. Valid values are ARM64 or X86_64., archiveSizeBytes: str(int64) # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., deprecated: map{deleted: str, deprecated: str, obsolete: str, replacement: str, state: str} # Deprecation status for a public resource., description: str # An optional description of this resource. Provide this property when you create the resource., diskSizeGb: str(int64) # Size of the image when restored onto a persistent disk (in GB)., family: str # The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035., guestOsFeatures: [map{type: str}] # A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., imageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, kind: str=compute#image # [Output Only] Type of the resource. Always compute#image for images., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image., labels: map # Labels to apply to this image. These can be later modified by the setLabels method., licenseCodes: [str(int64)] # Integer license codes indicating which licenses are attached to this image., licenses: [str] # Any applicable license URI., name: str # 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., rawDisk: map{containerType: str, sha1Checksum: str, source: str} # The parameters of the raw disk image., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined URL for the resource., shieldedInstanceInitialState: map{dbs: [map], dbxs: [map], keks: [map], pk: map} # Initial State for shielded instance, these are public keys which are safe to store in public, sourceDisk: str # URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL, sourceDiskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceDiskId: str # [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name., sourceImage: str # URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL, sourceImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceImageId: str # [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name., sourceSnapshot: str # URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL, sourceSnapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceSnapshotId: str # [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name., sourceType: str=RAW # The type of the image used to create this disk. The default and only valid value is RAW., status: str(DELETING/FAILED/PENDING/READY) # [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., storageLocations: [str] # Cloud Storage bucket storage location of the image (regional or multi-regional).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/images/{image}/deprecate\n@desc Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.\n@required {image: str # Image name.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., deleted: str # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it., deprecated: str # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it., obsolete: str # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it., replacement: str # 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: str(ACTIVE/DELETED/DEPRECATED/OBSOLETE) # The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/images/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/global/images/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/global/images/{resource}/setLabels\n@desc Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint., labels: map # A list of labels to apply for this resource. Each label must comply with the requirements for labels. For example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\").}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/images/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/global/instanceTemplates\n@desc Retrieves a list of instance templates that are contained within the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/instanceTemplates\n@desc 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.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] The creation timestamp for this instance template in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] A unique identifier for this instance template. The server defines this identifier., kind: str=compute#instanceTemplate # [Output Only] The resource type, which is always compute#instanceTemplate for instance templates., name: str # 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., properties: map{advancedMachineFeatures: map, canIpForward: bool, confidentialInstanceConfig: map, description: str, disks: [map], guestAccelerators: [map], keyRevocationActionType: str, labels: map, machineType: str, metadata: map, minCpuPlatform: str, networkInterfaces: [map], networkPerformanceConfig: map, privateIpv6GoogleAccess: str, reservationAffinity: map, resourceManagerTags: map, resourcePolicies: [str], scheduling: map, serviceAccounts: [map], shieldedInstanceConfig: map, tags: map}, region: str # [Output Only] URL of the region where the instance template resides. Only applicable for regional resources., selfLink: str # [Output Only] The URL for this instance template. The server defines this URL., sourceInstance: str # The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance, sourceInstanceParams: map{diskConfigs: [map]} # A specification of the parameters to use when creating the instance template from a source instance.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/instanceTemplates/{instanceTemplate}\n@desc Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group.\n@required {instanceTemplate: str # The name of the instance template to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/instanceTemplates/{instanceTemplate}\n@desc Returns the specified instance template.\n@required {instanceTemplate: str # The name of the instance template.}\n@returns(200) {creationTimestamp: str, description: str, id: str(uint64), kind: str, name: str, properties: map{advancedMachineFeatures: map{enableNestedVirtualization: bool, enableUefiNetworking: bool, threadsPerCore: int(int32), visibleCoreCount: int(int32)}, canIpForward: bool, confidentialInstanceConfig: map{enableConfidentialCompute: bool}, description: str, disks: [map], guestAccelerators: [map], keyRevocationActionType: str, labels: map, machineType: str, metadata: map{fingerprint: str(byte), items: [map], kind: str}, minCpuPlatform: str, networkInterfaces: [map], networkPerformanceConfig: map{totalEgressBandwidthTier: str}, privateIpv6GoogleAccess: str, reservationAffinity: map{consumeReservationType: str, key: str, values: [str]}, resourceManagerTags: map, resourcePolicies: [str], scheduling: map{automaticRestart: bool, instanceTerminationAction: str, locationHint: str, minNodeCpus: int(int32), nodeAffinities: [map], onHostMaintenance: str, preemptible: bool, provisioningModel: str}, serviceAccounts: [map], shieldedInstanceConfig: map{enableIntegrityMonitoring: bool, enableSecureBoot: bool, enableVtpm: bool}, tags: map{fingerprint: str(byte), items: [str]}}, region: str, selfLink: str, sourceInstance: str, sourceInstanceParams: map{diskConfigs: [map]}} # Successful response\n\n@endpoint GET /projects/{project}/global/instanceTemplates/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/global/instanceTemplates/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/global/instanceTemplates/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/global/interconnectLocations\n@desc Retrieves the list of interconnect locations available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/global/interconnectLocations/{interconnectLocation}\n@desc Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.\n@required {interconnectLocation: str # Name of the interconnect location to return.}\n@returns(200) {address: str, availabilityZone: str, city: str, continent: str, creationTimestamp: str, description: str, facilityProvider: str, facilityProviderFacilityId: str, id: str(uint64), kind: str, name: str, peeringdbFacilityId: str, regionInfos: [map], selfLink: str, status: str, supportsPzs: bool} # Successful response\n\n@endpoint GET /projects/{project}/global/interconnects\n@desc Retrieves the list of Interconnects available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/interconnects\n@desc Creates an Interconnect in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., adminEnabled: bool # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true., circuitInfos: [map{customerDemarcId: str, googleCircuitId: str, googleDemarcId: str}] # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customerName: str # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect., description: str # An optional description of this resource. Provide this property when you create the resource., expectedOutages: [map{affectedCircuits: [str], description: str, endTime: str(int64), issueType: str, name: str, source: str, startTime: str(int64), state: str}] # [Output Only] A list of outages expected for this Interconnect., googleIpAddress: str # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests., googleReferenceId: str # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., interconnectAttachments: [str] # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect., interconnectType: str(DEDICATED/IT_PRIVATE/PARTNER) # Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED., kind: str=compute#interconnect # [Output Only] Type of the resource. Always compute#interconnect for interconnects., linkType: str(LINK_TYPE_ETHERNET_100G_LR/LINK_TYPE_ETHERNET_10G_LR) # Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle., location: str # URL of the InterconnectLocation object that represents where this connection is to be provisioned., name: str # 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., nocContactEmail: str # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation., operationalStatus: str(OS_ACTIVE/OS_UNPROVISIONED) # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect., peerIpAddress: str # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests., provisionedLinkCount: int(int32) # [Output Only] Number of links actually provisioned in this interconnect., requestedLinkCount: int(int32) # Target number of physical links in the link bundle, as requested by the customer., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined URL for the resource., state: str(ACTIVE/UNPROVISIONED) # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/interconnects/{interconnect}\n@desc Deletes the specified Interconnect.\n@required {interconnect: str # Name of the interconnect to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/interconnects/{interconnect}\n@desc Returns the specified Interconnect. Get a list of available Interconnects by making a list() request.\n@required {interconnect: str # Name of the interconnect to return.}\n@returns(200) {adminEnabled: bool, circuitInfos: [map], creationTimestamp: str, customerName: str, description: str, expectedOutages: [map], googleIpAddress: str, googleReferenceId: str, id: str(uint64), interconnectAttachments: [str], interconnectType: str, kind: str, linkType: str, location: str, name: str, nocContactEmail: str, operationalStatus: str, peerIpAddress: str, provisionedLinkCount: int(int32), requestedLinkCount: int(int32), satisfiesPzs: bool, selfLink: str, state: str} # Successful response\n\n@endpoint PATCH /projects/{project}/global/interconnects/{interconnect}\n@desc Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {interconnect: str # Name of the interconnect to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., adminEnabled: bool # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true., circuitInfos: [map{customerDemarcId: str, googleCircuitId: str, googleDemarcId: str}] # [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customerName: str # Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect., description: str # An optional description of this resource. Provide this property when you create the resource., expectedOutages: [map{affectedCircuits: [str], description: str, endTime: str(int64), issueType: str, name: str, source: str, startTime: str(int64), state: str}] # [Output Only] A list of outages expected for this Interconnect., googleIpAddress: str # [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests., googleReferenceId: str # [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., interconnectAttachments: [str] # [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect., interconnectType: str(DEDICATED/IT_PRIVATE/PARTNER) # Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED., kind: str=compute#interconnect # [Output Only] Type of the resource. Always compute#interconnect for interconnects., linkType: str(LINK_TYPE_ETHERNET_100G_LR/LINK_TYPE_ETHERNET_10G_LR) # Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle., location: str # URL of the InterconnectLocation object that represents where this connection is to be provisioned., name: str # 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., nocContactEmail: str # Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation., operationalStatus: str(OS_ACTIVE/OS_UNPROVISIONED) # [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect., peerIpAddress: str # [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests., provisionedLinkCount: int(int32) # [Output Only] Number of links actually provisioned in this interconnect., requestedLinkCount: int(int32) # Target number of physical links in the link bundle, as requested by the customer., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined URL for the resource., state: str(ACTIVE/UNPROVISIONED) # [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/interconnects/{interconnect}/getDiagnostics\n@desc Returns the interconnectDiagnostics for the specified Interconnect.\n@required {interconnect: str # Name of the interconnect resource to query.}\n@returns(200) {result: map{arpCaches: [map], bundleAggregationType: str, bundleOperationalStatus: str, links: [map], macAddress: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/interconnects/{resource}/setLabels\n@desc Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint., labels: map # A list of labels to apply for this resource. Each label must comply with the requirements for labels. For example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\").}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/licenseCodes/{licenseCode}\n@desc Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.\n@required {licenseCode: str # Number corresponding to the License code resource to return.}\n@returns(200) {creationTimestamp: str, description: str, id: str(uint64), kind: str, licenseAlias: [map], name: str, selfLink: str, state: str, transferable: bool} # Successful response\n\n@endpoint POST /projects/{project}/global/licenseCodes/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/global/licenses\n@desc Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/licenses\n@desc Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., chargesUseFee: bool # [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional textual description of the resource; provided by the client when the resource is created., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#license # [Output Only] Type of resource. Always compute#license for licenses., licenseCode: str(uint64) # [Output Only] The unique code used to attach this license to images, snapshots, and disks., name: str # Name of the resource. The name must be 1-63 characters long and comply with RFC1035., resourceRequirements: map{minGuestCpuCount: int(int32), minMemoryMb: int(int32)}, selfLink: str # [Output Only] Server-defined URL for the resource., transferable: bool # If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/licenses/{license}\n@desc Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.\n@required {license: str # Name of the license resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/licenses/{license}\n@desc Returns the specified License resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.\n@required {license: str # Name of the License resource to return.}\n@returns(200) {chargesUseFee: bool, creationTimestamp: str, description: str, id: str(uint64), kind: str, licenseCode: str(uint64), name: str, resourceRequirements: map{minGuestCpuCount: int(int32), minMemoryMb: int(int32)}, selfLink: str, transferable: bool} # Successful response\n\n@endpoint GET /projects/{project}/global/licenses/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/global/licenses/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/global/licenses/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/global/machineImages\n@desc Retrieves a list of machine images that are contained within the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/machineImages\n@desc Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sourceInstance: str # Required. Source instance that is used to create the machine image from., creationTimestamp: str # [Output Only] The creation timestamp for this machine image in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., guestFlush: bool # [Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process., id: str(uint64) # [Output Only] A unique identifier for this machine image. The server defines this identifier., instanceProperties: map{advancedMachineFeatures: map, canIpForward: bool, confidentialInstanceConfig: map, description: str, disks: [map], guestAccelerators: [map], keyRevocationActionType: str, labels: map, machineType: str, metadata: map, minCpuPlatform: str, networkInterfaces: [map], networkPerformanceConfig: map, privateIpv6GoogleAccess: str, reservationAffinity: map, resourceManagerTags: map, resourcePolicies: [str], scheduling: map, serviceAccounts: [map], shieldedInstanceConfig: map, tags: map}, kind: str=compute#machineImage # [Output Only] The resource type, which is always compute#machineImage for machine image., machineImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, name: str # 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., satisfiesPzs: bool # [Output Only] Reserved for future use., savedDisks: [map{architecture: str, kind: str, sourceDisk: str, storageBytes: str(int64), storageBytesStatus: str}] # An array of Machine Image specific properties for disks attached to the source instance, selfLink: str # [Output Only] The URL for this machine image. The server defines this URL., sourceDiskEncryptionKeys: [map{diskEncryptionKey: map, sourceDisk: str}] # [Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key., sourceInstance: str # The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance, sourceInstanceProperties: map{canIpForward: bool, deletionProtection: bool, description: str, disks: [map], guestAccelerators: [map], keyRevocationActionType: str, labels: map, machineType: str, metadata: map, minCpuPlatform: str, networkInterfaces: [map], scheduling: map, serviceAccounts: [map], tags: map} # DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field., status: str(CREATING/DELETING/INVALID/READY/UPLOADING) # [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING., storageLocations: [str] # The regional or multi-regional Cloud Storage bucket location where the machine image is stored., totalStorageBytes: str(int64) # [Output Only] Total size of the storage used by the machine image.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/machineImages/{machineImage}\n@desc Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone.\n@required {machineImage: str # The name of the machine image to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/machineImages/{machineImage}\n@desc Returns the specified machine image.\n@required {machineImage: str # The name of the machine image.}\n@returns(200) {creationTimestamp: str, description: str, guestFlush: bool, id: str(uint64), instanceProperties: map{advancedMachineFeatures: map{enableNestedVirtualization: bool, enableUefiNetworking: bool, threadsPerCore: int(int32), visibleCoreCount: int(int32)}, canIpForward: bool, confidentialInstanceConfig: map{enableConfidentialCompute: bool}, description: str, disks: [map], guestAccelerators: [map], keyRevocationActionType: str, labels: map, machineType: str, metadata: map{fingerprint: str(byte), items: [map], kind: str}, minCpuPlatform: str, networkInterfaces: [map], networkPerformanceConfig: map{totalEgressBandwidthTier: str}, privateIpv6GoogleAccess: str, reservationAffinity: map{consumeReservationType: str, key: str, values: [str]}, resourceManagerTags: map, resourcePolicies: [str], scheduling: map{automaticRestart: bool, instanceTerminationAction: str, locationHint: str, minNodeCpus: int(int32), nodeAffinities: [map], onHostMaintenance: str, preemptible: bool, provisioningModel: str}, serviceAccounts: [map], shieldedInstanceConfig: map{enableIntegrityMonitoring: bool, enableSecureBoot: bool, enableVtpm: bool}, tags: map{fingerprint: str(byte), items: [str]}}, kind: str, machineImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, name: str, satisfiesPzs: bool, savedDisks: [map], selfLink: str, sourceDiskEncryptionKeys: [map], sourceInstance: str, sourceInstanceProperties: map{canIpForward: bool, deletionProtection: bool, description: str, disks: [map], guestAccelerators: [map], keyRevocationActionType: str, labels: map, machineType: str, metadata: map{fingerprint: str(byte), items: [map], kind: str}, minCpuPlatform: str, networkInterfaces: [map], scheduling: map{automaticRestart: bool, instanceTerminationAction: str, locationHint: str, minNodeCpus: int(int32), nodeAffinities: [map], onHostMaintenance: str, preemptible: bool, provisioningModel: str}, serviceAccounts: [map], tags: map{fingerprint: str(byte), items: [str]}}, status: str, storageLocations: [str], totalStorageBytes: str(int64)} # Successful response\n\n@endpoint GET /projects/{project}/global/machineImages/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/global/machineImages/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/global/machineImages/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/global/networkEndpointGroups\n@desc Retrieves the list of network endpoint groups that are located in the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/networkEndpointGroups\n@desc Creates a network endpoint group in the specified project using the parameters that are included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., annotations: map # Metadata defined as annotations on the network endpoint group., appEngine: map{service: str, urlMask: str, version: str} # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG., cloudFunction: map{function: str, urlMask: str} # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG., cloudRun: map{service: str, tag: str, urlMask: str} # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., defaultPort: int(int32) # The default port used if the port number is not specified in the network endpoint., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#networkEndpointGroup # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group., name: str # 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., network: str # The URL of the network to which all network endpoints in the NEG belong. Uses \"default\" project network if unspecified., networkEndpointType: str(GCE_VM_IP/GCE_VM_IP_PORT/INTERNET_FQDN_PORT/INTERNET_IP_PORT/NON_GCP_PRIVATE_IP_PORT/PRIVATE_SERVICE_CONNECT/SERVERLESS) # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT., pscData: map{consumerPscAddress: str, pscConnectionId: str(uint64), pscConnectionStatus: str} # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT., pscTargetService: str # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: \"asia-northeast3-cloudkms.googleapis.com\", region: str # [Output Only] The URL of the region where the network endpoint group is located., selfLink: str # [Output Only] Server-defined URL for the resource., size: int(int32) # [Output only] Number of network endpoints in the network endpoint group., subnetwork: str # Optional URL of the subnetwork to which all network endpoints in the NEG belong., zone: str # [Output Only] The URL of the zone where the network endpoint group is located.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}\n@desc Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.\n@required {networkEndpointGroup: str # The name of the network endpoint group to delete. It should comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}\n@desc Returns the specified network endpoint group.\n@required {networkEndpointGroup: str # The name of the network endpoint group. It should comply with RFC1035.}\n@returns(200) {annotations: map, appEngine: map{service: str, urlMask: str, version: str}, cloudFunction: map{function: str, urlMask: str}, cloudRun: map{service: str, tag: str, urlMask: str}, creationTimestamp: str, defaultPort: int(int32), description: str, id: str(uint64), kind: str, name: str, network: str, networkEndpointType: str, pscData: map{consumerPscAddress: str, pscConnectionId: str(uint64), pscConnectionStatus: str}, pscTargetService: str, region: str, selfLink: str, size: int(int32), subnetwork: str, zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints\n@desc Attach a network endpoint to the specified network endpoint group.\n@required {networkEndpointGroup: str # The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., networkEndpoints: [map{annotations: map, fqdn: str, instance: str, ipAddress: str, port: int(int32)}] # The list of network endpoints to be attached.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints\n@desc Detach the network endpoint from the specified network endpoint group.\n@required {networkEndpointGroup: str # The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., networkEndpoints: [map{annotations: map, fqdn: str, instance: str, ipAddress: str, port: int(int32)}] # The list of network endpoints to be detached.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints\n@desc Lists the network endpoints in the specified network endpoint group.\n@required {networkEndpointGroup: str # The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/global/networks\n@desc Retrieves the list of networks available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/networks\n@desc Creates a network in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., IPv4Range: str # Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created., autoCreateSubnetworks: bool # Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this field when you create the resource., enableUlaInternalIpv6: bool # Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. ., firewallPolicy: str # [Output Only] URL of the firewall policy the network is associated with., gatewayIPv4: str # [Output Only] The gateway address for default routing out of the network, selected by Google Cloud., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., internalIpv6Range: str # When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. ., kind: str=compute#network # [Output Only] Type of the resource. Always compute#network for networks., mtu: int(int32) # Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460., name: str # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit., networkFirewallPolicyEnforcementOrder: str(AFTER_CLASSIC_FIREWALL/BEFORE_CLASSIC_FIREWALL) # The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified., peerings: [map{autoCreateRoutes: bool, exchangeSubnetRoutes: bool, exportCustomRoutes: bool, exportSubnetRoutesWithPublicIp: bool, importCustomRoutes: bool, importSubnetRoutesWithPublicIp: bool, name: str, network: str, peerMtu: int(int32), stackType: str, state: str, stateDetails: str}] # [Output Only] A list of network peerings for the resource., routingConfig: map{routingMode: str} # A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide., selfLink: str # [Output Only] Server-defined URL for the resource., selfLinkWithId: str # [Output Only] Server-defined URL for this resource with the resource id., subnetworks: [str] # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/networks/{network}\n@desc Deletes the specified network.\n@required {network: str # Name of the network to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/networks/{network}\n@desc Returns the specified network.\n@required {network: str # Name of the network to return.}\n@returns(200) {IPv4Range: str, autoCreateSubnetworks: bool, creationTimestamp: str, description: str, enableUlaInternalIpv6: bool, firewallPolicy: str, gatewayIPv4: str, id: str(uint64), internalIpv6Range: str, kind: str, mtu: int(int32), name: str, networkFirewallPolicyEnforcementOrder: str, peerings: [map], routingConfig: map{routingMode: str}, selfLink: str, selfLinkWithId: str, subnetworks: [str]} # Successful response\n\n@endpoint PATCH /projects/{project}/global/networks/{network}\n@desc Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.\n@required {network: str # Name of the network to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., IPv4Range: str # Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created., autoCreateSubnetworks: bool # Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this field when you create the resource., enableUlaInternalIpv6: bool # Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. ., firewallPolicy: str # [Output Only] URL of the firewall policy the network is associated with., gatewayIPv4: str # [Output Only] The gateway address for default routing out of the network, selected by Google Cloud., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., internalIpv6Range: str # When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. ., kind: str=compute#network # [Output Only] Type of the resource. Always compute#network for networks., mtu: int(int32) # Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460., name: str # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit., networkFirewallPolicyEnforcementOrder: str(AFTER_CLASSIC_FIREWALL/BEFORE_CLASSIC_FIREWALL) # The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified., peerings: [map{autoCreateRoutes: bool, exchangeSubnetRoutes: bool, exportCustomRoutes: bool, exportSubnetRoutesWithPublicIp: bool, importCustomRoutes: bool, importSubnetRoutesWithPublicIp: bool, name: str, network: str, peerMtu: int(int32), stackType: str, state: str, stateDetails: str}] # [Output Only] A list of network peerings for the resource., routingConfig: map{routingMode: str} # A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide., selfLink: str # [Output Only] Server-defined URL for the resource., selfLinkWithId: str # [Output Only] Server-defined URL for this resource with the resource id., subnetworks: [str] # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/networks/{network}/addPeering\n@desc Adds a peering to the specified network.\n@required {network: str # Name of the network resource to add peering to.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoCreateRoutes: bool # This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE., name: str # Name of the peering, which should conform to RFC1035., networkPeering: map{autoCreateRoutes: bool, exchangeSubnetRoutes: bool, exportCustomRoutes: bool, exportSubnetRoutesWithPublicIp: bool, importCustomRoutes: bool, importSubnetRoutesWithPublicIp: bool, name: str, network: str, peerMtu: int(int32), stackType: str, state: str, stateDetails: str} # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering., peerNetwork: str # URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/networks/{network}/getEffectiveFirewalls\n@desc Returns the effective firewalls on a given network.\n@required {network: str # Name of the network for this request.}\n@returns(200) {firewallPolicys: [map], firewalls: [map]} # Successful response\n\n@endpoint GET /projects/{project}/global/networks/{network}/listPeeringRoutes\n@desc Lists the peering routes exchanged over peering connection.\n@required {network: str # Name of the network for this request.}\n@optional {direction: str(INCOMING/OUTGOING) # The direction of the exchanged routes., filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., peeringName: str # The response will show routes exchanged over the given peering connection., region: str # The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/networks/{network}/removePeering\n@desc Removes a peering from the specified network.\n@required {network: str # Name of the network resource to remove peering from.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., name: str # Name of the peering, which should conform to RFC1035.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/networks/{network}/switchToCustomMode\n@desc Switches the network mode from auto subnet mode to custom subnet mode.\n@required {network: str # Name of the network to be updated.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PATCH /projects/{project}/global/networks/{network}/updatePeering\n@desc Updates the specified network peering with the data included in the request. You can only modify the NetworkPeering.export_custom_routes field and the NetworkPeering.import_custom_routes field.\n@required {network: str # Name of the network resource which the updated peering is belonging to.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., networkPeering: map{autoCreateRoutes: bool, exchangeSubnetRoutes: bool, exportCustomRoutes: bool, exportSubnetRoutesWithPublicIp: bool, importCustomRoutes: bool, importSubnetRoutesWithPublicIp: bool, name: str, network: str, peerMtu: int(int32), stackType: str, state: str, stateDetails: str} # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/operations\n@desc Retrieves a list of Operation resources contained within the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint DELETE /projects/{project}/global/operations/{operation}\n@desc Deletes the specified Operations resource.\n@required {operation: str # Name of the Operations resource to delete.}\n@returns(200) Successful response\n\n@endpoint GET /projects/{project}/global/operations/{operation}\n@desc Retrieves the specified Operations resource.\n@required {operation: str # Name of the Operations resource to return.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/operations/{operation}/wait\n@desc Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`.\n@required {operation: str # Name of the Operations resource to return.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/publicAdvertisedPrefixes\n@desc Lists the PublicAdvertisedPrefixes for a project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/publicAdvertisedPrefixes\n@desc Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., dnsVerificationIp: str # The IPv4 address to be used for reverse DNS verification., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix., id: str(uint64) # [Output Only] The unique identifier for the resource type. The server generates this identifier., ipCidrRange: str # The IPv4 address range, in CIDR format, represented by this public advertised prefix., kind: str=compute#publicAdvertisedPrefix # [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes., name: str # 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., publicDelegatedPrefixs: [map{ipRange: str, name: str, project: str, region: str, status: str}] # [Output Only] The list of public delegated prefixes that exist for this public advertised prefix., selfLink: str # [Output Only] Server-defined URL for the resource., sharedSecret: str # [Output Only] The shared secret to be used for reverse DNS verification., status: str(INITIAL/PREFIX_CONFIGURATION_COMPLETE/PREFIX_CONFIGURATION_IN_PROGRESS/PREFIX_REMOVAL_IN_PROGRESS/PTR_CONFIGURED/REVERSE_DNS_LOOKUP_FAILED/VALIDATED) # The status of the public advertised prefix. Possible values include: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}\n@desc Deletes the specified PublicAdvertisedPrefix\n@required {publicAdvertisedPrefix: str # Name of the PublicAdvertisedPrefix resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}\n@desc Returns the specified PublicAdvertisedPrefix resource.\n@required {publicAdvertisedPrefix: str # Name of the PublicAdvertisedPrefix resource to return.}\n@returns(200) {creationTimestamp: str, description: str, dnsVerificationIp: str, fingerprint: str(byte), id: str(uint64), ipCidrRange: str, kind: str, name: str, publicDelegatedPrefixs: [map], selfLink: str, sharedSecret: str, status: str} # Successful response\n\n@endpoint PATCH /projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}\n@desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.\n@required {publicAdvertisedPrefix: str # Name of the PublicAdvertisedPrefix resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., dnsVerificationIp: str # The IPv4 address to be used for reverse DNS verification., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix., id: str(uint64) # [Output Only] The unique identifier for the resource type. The server generates this identifier., ipCidrRange: str # The IPv4 address range, in CIDR format, represented by this public advertised prefix., kind: str=compute#publicAdvertisedPrefix # [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes., name: str # 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., publicDelegatedPrefixs: [map{ipRange: str, name: str, project: str, region: str, status: str}] # [Output Only] The list of public delegated prefixes that exist for this public advertised prefix., selfLink: str # [Output Only] Server-defined URL for the resource., sharedSecret: str # [Output Only] The shared secret to be used for reverse DNS verification., status: str(INITIAL/PREFIX_CONFIGURATION_COMPLETE/PREFIX_CONFIGURATION_IN_PROGRESS/PREFIX_REMOVAL_IN_PROGRESS/PTR_CONFIGURED/REVERSE_DNS_LOOKUP_FAILED/VALIDATED) # The status of the public advertised prefix. Possible values include: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/publicDelegatedPrefixes\n@desc Lists the global PublicDelegatedPrefixes for a project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/publicDelegatedPrefixes\n@desc Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix., id: str(uint64) # [Output Only] The unique identifier for the resource type. The server generates this identifier., ipCidrRange: str # The IPv4 address range, in CIDR format, represented by this public delegated prefix., isLiveMigration: bool # If true, the prefix will be live migrated., kind: str=compute#publicDelegatedPrefix # [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes., name: str # 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., parentPrefix: str # The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix., publicDelegatedSubPrefixs: [map{delegateeProject: str, description: str, ipCidrRange: str, isAddress: bool, name: str, region: str, status: str}] # The list of sub public delegated prefixes that exist for this public delegated prefix., region: str # [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., status: str(ANNOUNCED/DELETING/INITIALIZING/READY_TO_ANNOUNCE) # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}\n@desc Deletes the specified global PublicDelegatedPrefix.\n@required {publicDelegatedPrefix: str # Name of the PublicDelegatedPrefix resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}\n@desc Returns the specified global PublicDelegatedPrefix resource.\n@required {publicDelegatedPrefix: str # Name of the PublicDelegatedPrefix resource to return.}\n@returns(200) {creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), ipCidrRange: str, isLiveMigration: bool, kind: str, name: str, parentPrefix: str, publicDelegatedSubPrefixs: [map], region: str, selfLink: str, status: str} # Successful response\n\n@endpoint PATCH /projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}\n@desc Patches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.\n@required {publicDelegatedPrefix: str # Name of the PublicDelegatedPrefix resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix., id: str(uint64) # [Output Only] The unique identifier for the resource type. The server generates this identifier., ipCidrRange: str # The IPv4 address range, in CIDR format, represented by this public delegated prefix., isLiveMigration: bool # If true, the prefix will be live migrated., kind: str=compute#publicDelegatedPrefix # [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes., name: str # 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., parentPrefix: str # The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix., publicDelegatedSubPrefixs: [map{delegateeProject: str, description: str, ipCidrRange: str, isAddress: bool, name: str, region: str, status: str}] # The list of sub public delegated prefixes that exist for this public delegated prefix., region: str # [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., status: str(ANNOUNCED/DELETING/INITIALIZING/READY_TO_ANNOUNCE) # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/routes\n@desc Retrieves the list of Route resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/routes\n@desc Creates a Route resource in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., asPaths: [map{asLists: [int(uint32)], pathSegmentType: str}] # [Output Only] AS path., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this field when you create the resource., destRange: str # The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#route # [Output Only] Type of this resource. Always compute#routes for Route resources., name: str # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit., network: str # Fully-qualified URL of the network that this route applies to., nextHopGateway: str # The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway, nextHopIlb: str # The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule, nextHopInstance: str # The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/, nextHopIp: str # The network IP address of an instance that should handle matching packets. Only IPv4 is supported., nextHopNetwork: str # The URL of the local network if it should handle matching packets., nextHopPeering: str # [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035., nextHopVpnTunnel: str # The URL to a VpnTunnel that should handle matching packets., priority: int(uint32) # The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive., routeStatus: str(ACTIVE/DROPPED/INACTIVE/PENDING) # [Output only] The status of the route., routeType: str(BGP/STATIC/SUBNET/TRANSIT) # [Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route, selfLink: str # [Output Only] Server-defined fully-qualified URL for this resource., tags: [str] # A list of instance tags to which this route applies., warnings: [map{code: str, data: [map], message: str}] # [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/routes/{route}\n@desc Deletes the specified Route resource.\n@required {route: str # Name of the Route resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/routes/{route}\n@desc Returns the specified Route resource.\n@required {route: str # Name of the Route resource to return.}\n@returns(200) {asPaths: [map], creationTimestamp: str, description: str, destRange: str, id: str(uint64), kind: str, name: str, network: str, nextHopGateway: str, nextHopIlb: str, nextHopInstance: str, nextHopIp: str, nextHopNetwork: str, nextHopPeering: str, nextHopVpnTunnel: str, priority: int(uint32), routeStatus: str, routeType: str, selfLink: str, tags: [str], warnings: [map]} # Successful response\n\n@endpoint GET /projects/{project}/global/securityPolicies\n@desc List all the policies that have been configured for the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/securityPolicies\n@desc Creates a new policy in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., validateOnly: bool # If true, the request will not be committed., adaptiveProtectionConfig: map{layer7DdosDefenseConfig: map} # Configuration options for Cloud Armor Adaptive Protection (CAAP)., advancedOptionsConfig: map{jsonCustomConfig: map, jsonParsing: str, logLevel: str}, creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., ddosProtectionConfig: map{ddosProtection: str}, description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#securityPolicy # [Output only] Type of the resource. Always compute#securityPolicyfor security policies, name: str # 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., recaptchaOptionsConfig: map{redirectSiteKey: str}, region: str # [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies., rules: [map{action: str, description: str, headerAction: map, kind: str, match: map, preconfiguredWafConfig: map, preview: bool, priority: int(int32), rateLimitOptions: map, redirectOptions: map}] # A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match \"*\" for srcIpRanges and for the networkMatch condition every field must be either match \"*\" or not set). If no rules are provided when creating a security policy, a default rule with action \"allow\" will be added., selfLink: str # [Output Only] Server-defined URL for the resource., type: str(CLOUD_ARMOR/CLOUD_ARMOR_EDGE/CLOUD_ARMOR_NETWORK) # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets\n@desc Gets the current list of preconfigured Web Application Firewall (WAF) expressions.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {preconfiguredExpressionSets: map{wafRules: map{expressionSets: [map]}}} # Successful response\n\n@endpoint POST /projects/{project}/global/securityPolicies/{resource}/setLabels\n@desc Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint., labels: map # A list of labels to apply for this resource. Each label must comply with the requirements for labels. For example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\").}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/securityPolicies/{securityPolicy}\n@desc Deletes the specified policy.\n@required {securityPolicy: str # Name of the security policy to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/securityPolicies/{securityPolicy}\n@desc List all of the ordered rules present in a single specified policy.\n@required {securityPolicy: str # Name of the security policy to get.}\n@returns(200) {adaptiveProtectionConfig: map{layer7DdosDefenseConfig: map{enable: bool, ruleVisibility: str}}, advancedOptionsConfig: map{jsonCustomConfig: map{contentTypes: [str]}, jsonParsing: str, logLevel: str}, creationTimestamp: str, ddosProtectionConfig: map{ddosProtection: str}, description: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, recaptchaOptionsConfig: map{redirectSiteKey: str}, region: str, rules: [map], selfLink: str, type: str} # Successful response\n\n@endpoint PATCH /projects/{project}/global/securityPolicies/{securityPolicy}\n@desc Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.\n@required {securityPolicy: str # Name of the security policy to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., adaptiveProtectionConfig: map{layer7DdosDefenseConfig: map} # Configuration options for Cloud Armor Adaptive Protection (CAAP)., advancedOptionsConfig: map{jsonCustomConfig: map, jsonParsing: str, logLevel: str}, creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., ddosProtectionConfig: map{ddosProtection: str}, description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#securityPolicy # [Output only] Type of the resource. Always compute#securityPolicyfor security policies, name: str # 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., recaptchaOptionsConfig: map{redirectSiteKey: str}, region: str # [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies., rules: [map{action: str, description: str, headerAction: map, kind: str, match: map, preconfiguredWafConfig: map, preview: bool, priority: int(int32), rateLimitOptions: map, redirectOptions: map}] # A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match \"*\" for srcIpRanges and for the networkMatch condition every field must be either match \"*\" or not set). If no rules are provided when creating a security policy, a default rule with action \"allow\" will be added., selfLink: str # [Output Only] Server-defined URL for the resource., type: str(CLOUD_ARMOR/CLOUD_ARMOR_EDGE/CLOUD_ARMOR_NETWORK) # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/securityPolicies/{securityPolicy}/addRule\n@desc Inserts a rule into a security policy.\n@required {securityPolicy: str # Name of the security policy to update.}\n@optional {validateOnly: bool # If true, the request will not be committed., action: str # The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this., description: str # An optional description of this resource. Provide this property when you create the resource., headerAction: map{requestHeadersToAdds: [map]}, kind: str=compute#securityPolicyRule # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules, match: map{config: map, expr: map, versionedExpr: str} # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified., preconfiguredWafConfig: map{exclusions: [map]}, preview: bool # If set to true, the specified action is not enforced., priority: int(int32) # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority., rateLimitOptions: map{banDurationSec: int(int32), banThreshold: map, conformAction: str, enforceOnKey: str, enforceOnKeyConfigs: [map], enforceOnKeyName: str, exceedAction: str, exceedRedirectOptions: map, rateLimitThreshold: map}, redirectOptions: map{target: str, type: str}}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/securityPolicies/{securityPolicy}/getRule\n@desc Gets a rule at the specified priority.\n@required {securityPolicy: str # Name of the security policy to which the queried rule belongs.}\n@optional {priority: int # The priority of the rule to get from the security policy.}\n@returns(200) {action: str, description: str, headerAction: map{requestHeadersToAdds: [map]}, kind: str, match: map{config: map{srcIpRanges: [str]}, expr: map{description: str, expression: str, location: str, title: str}, versionedExpr: str}, preconfiguredWafConfig: map{exclusions: [map]}, preview: bool, priority: int(int32), rateLimitOptions: map{banDurationSec: int(int32), banThreshold: map{count: int(int32), intervalSec: int(int32)}, conformAction: str, enforceOnKey: str, enforceOnKeyConfigs: [map], enforceOnKeyName: str, exceedAction: str, exceedRedirectOptions: map{target: str, type: str}, rateLimitThreshold: map{count: int(int32), intervalSec: int(int32)}}, redirectOptions: map{target: str, type: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/securityPolicies/{securityPolicy}/patchRule\n@desc Patches a rule at the specified priority.\n@required {securityPolicy: str # Name of the security policy to update.}\n@optional {priority: int # The priority of the rule to patch., validateOnly: bool # If true, the request will not be committed., action: str # The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this., description: str # An optional description of this resource. Provide this property when you create the resource., headerAction: map{requestHeadersToAdds: [map]}, kind: str=compute#securityPolicyRule # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules, match: map{config: map, expr: map, versionedExpr: str} # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified., preconfiguredWafConfig: map{exclusions: [map]}, preview: bool # If set to true, the specified action is not enforced., priority: int(int32) # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority., rateLimitOptions: map{banDurationSec: int(int32), banThreshold: map, conformAction: str, enforceOnKey: str, enforceOnKeyConfigs: [map], enforceOnKeyName: str, exceedAction: str, exceedRedirectOptions: map, rateLimitThreshold: map}, redirectOptions: map{target: str, type: str}}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/securityPolicies/{securityPolicy}/removeRule\n@desc Deletes a rule at the specified priority.\n@required {securityPolicy: str # Name of the security policy to update.}\n@optional {priority: int # The priority of the rule to remove from the security policy.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/snapshots\n@desc Retrieves the list of Snapshot resources contained within the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/snapshots\n@desc Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., architecture: str(ARCHITECTURE_UNSPECIFIED/ARM64/X86_64) # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64., autoCreated: bool # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk., chainName: str # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value., creationSizeBytes: str(int64) # [Output Only] Size in bytes of the snapshot at creation time., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., diskSizeGb: str(int64) # [Output Only] Size of the source disk, specified in GB., downloadBytes: str(int64) # [Output Only] Number of bytes downloaded to restore a snapshot to a disk., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#snapshot # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot., labels: map # Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty., licenseCodes: [str(int64)] # [Output Only] Integer license codes indicating which licenses are attached to this snapshot., licenses: [str] # [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)., locationHint: str # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API., name: str # 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., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined URL for the resource., snapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, snapshotType: str(ARCHIVE/STANDARD) # Indicates the type of the snapshot., sourceDisk: str # The source disk used to create this snapshot., sourceDiskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceDiskId: str # [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., sourceSnapshotSchedulePolicy: str # [Output Only] URL of the resource policy which created this scheduled snapshot., sourceSnapshotSchedulePolicyId: str # [Output Only] ID of the resource policy which created this scheduled snapshot., status: str(CREATING/DELETING/FAILED/READY/UPLOADING) # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING., storageBytes: str(int64) # [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion., storageBytesStatus: str(UPDATING/UP_TO_DATE) # [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., storageLocations: [str] # Cloud Storage bucket storage location of the snapshot (regional or multi-regional).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/snapshots/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/global/snapshots/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/global/snapshots/{resource}/setLabels\n@desc Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint., labels: map # A list of labels to apply for this resource. Each label must comply with the requirements for labels. For example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\").}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/snapshots/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint DELETE /projects/{project}/global/snapshots/{snapshot}\n@desc Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots.\n@required {snapshot: str # Name of the Snapshot resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/snapshots/{snapshot}\n@desc Returns the specified Snapshot resource.\n@required {snapshot: str # Name of the Snapshot resource to return.}\n@returns(200) {architecture: str, autoCreated: bool, chainName: str, creationSizeBytes: str(int64), creationTimestamp: str, description: str, diskSizeGb: str(int64), downloadBytes: str(int64), id: str(uint64), kind: str, labelFingerprint: str(byte), labels: map, licenseCodes: [str(int64)], licenses: [str], locationHint: str, name: str, satisfiesPzs: bool, selfLink: str, snapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, snapshotType: str, sourceDisk: str, sourceDiskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceDiskId: str, sourceSnapshotSchedulePolicy: str, sourceSnapshotSchedulePolicyId: str, status: str, storageBytes: str(int64), storageBytesStatus: str, storageLocations: [str]} # Successful response\n\n@endpoint GET /projects/{project}/global/sslCertificates\n@desc Retrieves the list of SslCertificate resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/sslCertificates\n@desc Creates a SslCertificate resource in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., certificate: str # A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., expireTime: str # [Output Only] Expire time of the certificate. RFC3339, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#sslCertificate # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates., managed: map{domainStatus: map, domains: [str], status: str} # Configuration and status of a managed SSL certificate., name: str # 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., privateKey: str # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field., region: str # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate., selfLink: str # [Output only] Server-defined URL for the resource., selfManaged: map{certificate: str, privateKey: str} # Configuration and status of a self-managed SSL certificate., subjectAlternativeNames: [str] # [Output Only] Domains associated with the certificate via Subject Alternative Name., type: str(MANAGED/SELF_MANAGED/TYPE_UNSPECIFIED) # (Optional) Specifies the type of SSL certificate, either \"SELF_MANAGED\" or \"MANAGED\". If not specified, the certificate is self-managed and the fields certificate and private_key are used.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/sslCertificates/{sslCertificate}\n@desc Deletes the specified SslCertificate resource.\n@required {sslCertificate: str # Name of the SslCertificate resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/sslCertificates/{sslCertificate}\n@desc Returns the specified SslCertificate resource.\n@required {sslCertificate: str # Name of the SslCertificate resource to return.}\n@returns(200) {certificate: str, creationTimestamp: str, description: str, expireTime: str, id: str(uint64), kind: str, managed: map{domainStatus: map, domains: [str], status: str}, name: str, privateKey: str, region: str, selfLink: str, selfManaged: map{certificate: str, privateKey: str}, subjectAlternativeNames: [str], type: str} # Successful response\n\n@endpoint GET /projects/{project}/global/sslPolicies\n@desc Lists all the SSL policies that have been configured for the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/sslPolicies\n@desc Returns the specified SSL policy resource.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customFeatures: [str] # A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM., description: str # An optional description of this resource. Provide this property when you create the resource., enabledFeatures: [str] # [Output Only] The list of features enabled in the SSL policy., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#sslPolicy # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies., minTlsVersion: str(TLS_1_0/TLS_1_1/TLS_1_2) # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2., name: str # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., profile: str(COMPATIBLE/CUSTOM/MODERN/RESTRICTED) # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field., region: str # [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies., selfLink: str # [Output Only] Server-defined URL for the resource., warnings: [map{code: str, data: [map], message: str}] # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/sslPolicies/listAvailableFeatures\n@desc Lists all features that can be specified in the SSL policy when using custom profile.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {features: [str]} # Successful response\n\n@endpoint DELETE /projects/{project}/global/sslPolicies/{sslPolicy}\n@desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.\n@required {sslPolicy: str # Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/sslPolicies/{sslPolicy}\n@desc Lists all of the ordered rules present in a single specified policy.\n@required {sslPolicy: str # Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.}\n@returns(200) {creationTimestamp: str, customFeatures: [str], description: str, enabledFeatures: [str], fingerprint: str(byte), id: str(uint64), kind: str, minTlsVersion: str, name: str, profile: str, region: str, selfLink: str, warnings: [map]} # Successful response\n\n@endpoint PATCH /projects/{project}/global/sslPolicies/{sslPolicy}\n@desc Patches the specified SSL policy with the data included in the request.\n@required {sslPolicy: str # Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customFeatures: [str] # A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM., description: str # An optional description of this resource. Provide this property when you create the resource., enabledFeatures: [str] # [Output Only] The list of features enabled in the SSL policy., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#sslPolicy # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies., minTlsVersion: str(TLS_1_0/TLS_1_1/TLS_1_2) # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2., name: str # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., profile: str(COMPATIBLE/CUSTOM/MODERN/RESTRICTED) # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field., region: str # [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies., selfLink: str # [Output Only] Server-defined URL for the resource., warnings: [map{code: str, data: [map], message: str}] # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/targetGrpcProxies\n@desc Lists the TargetGrpcProxies for a project in the given scope.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/targetGrpcProxies\n@desc Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetGrpcProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetGrpcProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetGrpcProxy., id: str(uint64) # [Output Only] The unique identifier for the resource type. The server generates this identifier., kind: str=compute#targetGrpcProxy # [Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies., name: str # 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., selfLink: str # [Output Only] Server-defined URL for the resource., selfLinkWithId: str # [Output Only] Server-defined URL with id for the resource., urlMap: str # URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC., validateForProxyless: bool # If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use \"xds:///\" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use \"xds:///\" scheme in the target URI of the service it is connecting to}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}\n@desc Deletes the specified TargetGrpcProxy in the given scope\n@required {targetGrpcProxy: str # Name of the TargetGrpcProxy resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}\n@desc Returns the specified TargetGrpcProxy resource in the given scope.\n@required {targetGrpcProxy: str # Name of the TargetGrpcProxy resource to return.}\n@returns(200) {creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, selfLink: str, selfLinkWithId: str, urlMap: str, validateForProxyless: bool} # Successful response\n\n@endpoint PATCH /projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}\n@desc Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.\n@required {targetGrpcProxy: str # Name of the TargetGrpcProxy resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetGrpcProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetGrpcProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetGrpcProxy., id: str(uint64) # [Output Only] The unique identifier for the resource type. The server generates this identifier., kind: str=compute#targetGrpcProxy # [Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies., name: str # 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., selfLink: str # [Output Only] Server-defined URL for the resource., selfLinkWithId: str # [Output Only] Server-defined URL with id for the resource., urlMap: str # URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC., validateForProxyless: bool # If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use \"xds:///\" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use \"xds:///\" scheme in the target URI of the service it is connecting to}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/targetHttpProxies\n@desc Retrieves the list of TargetHttpProxy resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/targetHttpProxies\n@desc Creates a TargetHttpProxy resource in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#targetHttpProxy # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies., name: str # 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., proxyBind: bool # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false., region: str # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies., selfLink: str # [Output Only] Server-defined URL for the resource., urlMap: str # URL to the UrlMap resource that defines the mapping from URL to the BackendService.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/targetHttpProxies/{targetHttpProxy}\n@desc Deletes the specified TargetHttpProxy resource.\n@required {targetHttpProxy: str # Name of the TargetHttpProxy resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/targetHttpProxies/{targetHttpProxy}\n@desc Returns the specified TargetHttpProxy resource.\n@required {targetHttpProxy: str # Name of the TargetHttpProxy resource to return.}\n@returns(200) {creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, proxyBind: bool, region: str, selfLink: str, urlMap: str} # Successful response\n\n@endpoint PATCH /projects/{project}/global/targetHttpProxies/{targetHttpProxy}\n@desc Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.\n@required {targetHttpProxy: str # Name of the TargetHttpProxy resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#targetHttpProxy # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies., name: str # 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., proxyBind: bool # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false., region: str # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies., selfLink: str # [Output Only] Server-defined URL for the resource., urlMap: str # URL to the UrlMap resource that defines the mapping from URL to the BackendService.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/targetHttpsProxies\n@desc Retrieves the list of TargetHttpsProxy resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/targetHttpsProxies\n@desc Creates a TargetHttpsProxy resource in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., authorizationPolicy: str # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact., certificateMap: str # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#targetHttpsProxy # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies., name: str # 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., proxyBind: bool # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false., quicOverride: str(DISABLE/ENABLE/NONE) # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied., region: str # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies., selfLink: str # [Output Only] Server-defined URL for the resource., serverTlsPolicy: str # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted., sslCertificates: [str] # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED., sslPolicy: str # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured., urlMap: str # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}\n@desc Deletes the specified TargetHttpsProxy resource.\n@required {targetHttpsProxy: str # Name of the TargetHttpsProxy resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}\n@desc Returns the specified TargetHttpsProxy resource.\n@required {targetHttpsProxy: str # Name of the TargetHttpsProxy resource to return.}\n@returns(200) {authorizationPolicy: str, certificateMap: str, creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, proxyBind: bool, quicOverride: str, region: str, selfLink: str, serverTlsPolicy: str, sslCertificates: [str], sslPolicy: str, urlMap: str} # Successful response\n\n@endpoint PATCH /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}\n@desc Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.\n@required {targetHttpsProxy: str # Name of the TargetHttpsProxy resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., authorizationPolicy: str # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact., certificateMap: str # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#targetHttpsProxy # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies., name: str # 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., proxyBind: bool # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false., quicOverride: str(DISABLE/ENABLE/NONE) # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied., region: str # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies., selfLink: str # [Output Only] Server-defined URL for the resource., serverTlsPolicy: str # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted., sslCertificates: [str] # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED., sslPolicy: str # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured., urlMap: str # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap\n@desc Changes the Certificate Map for TargetHttpsProxy.\n@required {targetHttpsProxy: str # Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., certificateMap: str # URL of the Certificate Map to associate with this TargetHttpsProxy.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride\n@desc Sets the QUIC override policy for TargetHttpsProxy.\n@required {targetHttpsProxy: str # Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., quicOverride: str(DISABLE/ENABLE/NONE) # QUIC policy for the TargetHttpsProxy resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy\n@desc Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.\n@required {targetHttpsProxy: str # Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sslPolicy: str # URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/targetSslProxies\n@desc Retrieves the list of TargetSslProxy resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/targetSslProxies\n@desc Creates a TargetSslProxy resource in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., certificateMap: str # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#targetSslProxy # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies., name: str # 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., proxyHeader: str(NONE/PROXY_V1) # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE., selfLink: str # [Output Only] Server-defined URL for the resource., service: str # URL to the BackendService resource., sslCertificates: [str] # URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED., sslPolicy: str # URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/targetSslProxies/{targetSslProxy}\n@desc Deletes the specified TargetSslProxy resource.\n@required {targetSslProxy: str # Name of the TargetSslProxy resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/targetSslProxies/{targetSslProxy}\n@desc Returns the specified TargetSslProxy resource.\n@required {targetSslProxy: str # Name of the TargetSslProxy resource to return.}\n@returns(200) {certificateMap: str, creationTimestamp: str, description: str, id: str(uint64), kind: str, name: str, proxyHeader: str, selfLink: str, service: str, sslCertificates: [str], sslPolicy: str} # Successful response\n\n@endpoint POST /projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService\n@desc Changes the BackendService for TargetSslProxy.\n@required {targetSslProxy: str # Name of the TargetSslProxy resource whose BackendService resource is to be set.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., service: str # The URL of the new BackendService resource for the targetSslProxy.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap\n@desc Changes the Certificate Map for TargetSslProxy.\n@required {targetSslProxy: str # Name of the TargetSslProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., certificateMap: str # URL of the Certificate Map to associate with this TargetSslProxy.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader\n@desc Changes the ProxyHeaderType for TargetSslProxy.\n@required {targetSslProxy: str # Name of the TargetSslProxy resource whose ProxyHeader is to be set.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., proxyHeader: str(NONE/PROXY_V1) # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates\n@desc Changes SslCertificates for TargetSslProxy.\n@required {targetSslProxy: str # Name of the TargetSslProxy resource whose SslCertificate resource is to be set.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sslCertificates: [str] # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy\n@desc Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends.\n@required {targetSslProxy: str # Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sslPolicy: str # URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/targetTcpProxies\n@desc Retrieves the list of TargetTcpProxy resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/targetTcpProxies\n@desc Creates a TargetTcpProxy resource in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#targetTcpProxy # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies., name: str # 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., proxyBind: bool # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false., proxyHeader: str(NONE/PROXY_V1) # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE., region: str # [Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy., selfLink: str # [Output Only] Server-defined URL for the resource., service: str # URL to the BackendService resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/targetTcpProxies/{targetTcpProxy}\n@desc Deletes the specified TargetTcpProxy resource.\n@required {targetTcpProxy: str # Name of the TargetTcpProxy resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/targetTcpProxies/{targetTcpProxy}\n@desc Returns the specified TargetTcpProxy resource.\n@required {targetTcpProxy: str # Name of the TargetTcpProxy resource to return.}\n@returns(200) {creationTimestamp: str, description: str, id: str(uint64), kind: str, name: str, proxyBind: bool, proxyHeader: str, region: str, selfLink: str, service: str} # Successful response\n\n@endpoint POST /projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService\n@desc Changes the BackendService for TargetTcpProxy.\n@required {targetTcpProxy: str # Name of the TargetTcpProxy resource whose BackendService resource is to be set.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., service: str # The URL of the new BackendService resource for the targetTcpProxy.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader\n@desc Changes the ProxyHeaderType for TargetTcpProxy.\n@required {targetTcpProxy: str # Name of the TargetTcpProxy resource whose ProxyHeader is to be set.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., proxyHeader: str(NONE/PROXY_V1) # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/urlMaps\n@desc Retrieves the list of UrlMap resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/global/urlMaps\n@desc Creates a UrlMap resource in the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., defaultRouteAction: map{corsPolicy: map, faultInjectionPolicy: map, maxStreamDuration: map, requestMirrorPolicy: map, retryPolicy: map, timeout: map, urlRewrite: map, weightedBackendServices: [map]}, defaultService: str # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true., defaultUrlRedirect: map{hostRedirect: str, httpsRedirect: bool, pathRedirect: str, prefixRedirect: str, redirectResponseCode: str, stripQuery: bool} # Specifies settings for an HTTP redirect., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap., headerAction: map{requestHeadersToAdd: [map], requestHeadersToRemove: [str], responseHeadersToAdd: [map], responseHeadersToRemove: [str]} # The request and response header transformations that take effect before the request is passed along to the selected backendService., hostRules: [map{description: str, hosts: [str], pathMatcher: str}] # The list of host rules to use against the URL., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#urlMap # [Output Only] Type of the resource. Always compute#urlMaps for url maps., name: str # 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., pathMatchers: [map{defaultRouteAction: map, defaultService: str, defaultUrlRedirect: map, description: str, headerAction: map, name: str, pathRules: [map], routeRules: [map]}] # The list of named PathMatchers to use against the URL., region: str # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., tests: [map{description: str, expectedOutputUrl: str, expectedRedirectResponseCode: int(int32), headers: [map], host: str, path: str, service: str}] # The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/global/urlMaps/{urlMap}\n@desc Deletes the specified UrlMap resource.\n@required {urlMap: str # Name of the UrlMap resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/global/urlMaps/{urlMap}\n@desc Returns the specified UrlMap resource.\n@required {urlMap: str # Name of the UrlMap resource to return.}\n@returns(200) {creationTimestamp: str, defaultRouteAction: map{corsPolicy: map{allowCredentials: bool, allowHeaders: [str], allowMethods: [str], allowOriginRegexes: [str], allowOrigins: [str], disabled: bool, exposeHeaders: [str], maxAge: int(int32)}, faultInjectionPolicy: map{abort: map{httpStatus: int(uint32), percentage: num(double)}, delay: map{fixedDelay: map, percentage: num(double)}}, maxStreamDuration: map{nanos: int(int32), seconds: str(int64)}, requestMirrorPolicy: map{backendService: str}, retryPolicy: map{numRetries: int(uint32), perTryTimeout: map{nanos: int(int32), seconds: str(int64)}, retryConditions: [str]}, timeout: map{nanos: int(int32), seconds: str(int64)}, urlRewrite: map{hostRewrite: str, pathPrefixRewrite: str}, weightedBackendServices: [map]}, defaultService: str, defaultUrlRedirect: map{hostRedirect: str, httpsRedirect: bool, pathRedirect: str, prefixRedirect: str, redirectResponseCode: str, stripQuery: bool}, description: str, fingerprint: str(byte), headerAction: map{requestHeadersToAdd: [map], requestHeadersToRemove: [str], responseHeadersToAdd: [map], responseHeadersToRemove: [str]}, hostRules: [map], id: str(uint64), kind: str, name: str, pathMatchers: [map], region: str, selfLink: str, tests: [map]} # Successful response\n\n@endpoint PATCH /projects/{project}/global/urlMaps/{urlMap}\n@desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {urlMap: str # Name of the UrlMap resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., defaultRouteAction: map{corsPolicy: map, faultInjectionPolicy: map, maxStreamDuration: map, requestMirrorPolicy: map, retryPolicy: map, timeout: map, urlRewrite: map, weightedBackendServices: [map]}, defaultService: str # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true., defaultUrlRedirect: map{hostRedirect: str, httpsRedirect: bool, pathRedirect: str, prefixRedirect: str, redirectResponseCode: str, stripQuery: bool} # Specifies settings for an HTTP redirect., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap., headerAction: map{requestHeadersToAdd: [map], requestHeadersToRemove: [str], responseHeadersToAdd: [map], responseHeadersToRemove: [str]} # The request and response header transformations that take effect before the request is passed along to the selected backendService., hostRules: [map{description: str, hosts: [str], pathMatcher: str}] # The list of host rules to use against the URL., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#urlMap # [Output Only] Type of the resource. Always compute#urlMaps for url maps., name: str # 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., pathMatchers: [map{defaultRouteAction: map, defaultService: str, defaultUrlRedirect: map, description: str, headerAction: map, name: str, pathRules: [map], routeRules: [map]}] # The list of named PathMatchers to use against the URL., region: str # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., tests: [map{description: str, expectedOutputUrl: str, expectedRedirectResponseCode: int(int32), headers: [map], host: str, path: str, service: str}] # The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/global/urlMaps/{urlMap}\n@desc Updates the specified UrlMap resource with the data included in the request.\n@required {urlMap: str # Name of the UrlMap resource to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., defaultRouteAction: map{corsPolicy: map, faultInjectionPolicy: map, maxStreamDuration: map, requestMirrorPolicy: map, retryPolicy: map, timeout: map, urlRewrite: map, weightedBackendServices: [map]}, defaultService: str # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true., defaultUrlRedirect: map{hostRedirect: str, httpsRedirect: bool, pathRedirect: str, prefixRedirect: str, redirectResponseCode: str, stripQuery: bool} # Specifies settings for an HTTP redirect., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap., headerAction: map{requestHeadersToAdd: [map], requestHeadersToRemove: [str], responseHeadersToAdd: [map], responseHeadersToRemove: [str]} # The request and response header transformations that take effect before the request is passed along to the selected backendService., hostRules: [map{description: str, hosts: [str], pathMatcher: str}] # The list of host rules to use against the URL., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#urlMap # [Output Only] Type of the resource. Always compute#urlMaps for url maps., name: str # 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., pathMatchers: [map{defaultRouteAction: map, defaultService: str, defaultUrlRedirect: map, description: str, headerAction: map, name: str, pathRules: [map], routeRules: [map]}] # The list of named PathMatchers to use against the URL., region: str # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., tests: [map{description: str, expectedOutputUrl: str, expectedRedirectResponseCode: int(int32), headers: [map], host: str, path: str, service: str}] # The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/urlMaps/{urlMap}/invalidateCache\n@desc Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).\n@required {urlMap: str # Name of the UrlMap scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., host: str # If set, this invalidation rule will only apply to requests with a Host header matching host., path: str}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/global/urlMaps/{urlMap}/validate\n@desc 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.\n@required {urlMap: str # Name of the UrlMap resource to be validated as.}\n@optional {loadBalancingSchemes: [str] # Specifies the load balancer type(s) this validation request is for. Use EXTERNAL_MANAGED for HTTP/HTTPS External Global Load Balancer with Advanced Traffic Management. Use EXTERNAL for Classic HTTP/HTTPS External Global Load Balancer. Other load balancer types are not supported. For more information, refer to Choosing a load balancer. If unspecified, the load balancing scheme will be inferred from the backend service resources this URL map references. If that can not be inferred (for example, this URL map only references backend buckets, or this Url map is for rewrites and redirects only and doesn't reference any backends), EXTERNAL will be used as the default type. If specified, the scheme(s) must not conflict with the load balancing scheme of the backend service resources this Url map references., resource: map{creationTimestamp: str, defaultRouteAction: map, defaultService: str, defaultUrlRedirect: map, description: str, fingerprint: str(byte), headerAction: map, hostRules: [map], id: str(uint64), kind: str, name: str, pathMatchers: [map], region: str, selfLink: str, tests: [map]} # Represents a URL Map resource. Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of cloud load balancers and Traffic Director: * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.}\n@returns(200) {result: map{loadErrors: [str], loadSucceeded: bool, testFailures: [map], testPassed: bool}} # Successful response\n\n@endpoint POST /projects/{project}/listXpnHosts\n@desc Lists all shared VPC host projects visible to the user in an organization.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false., organization: str # Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/moveDisk\n@desc Moves a persistent disk from one zone to another.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., destinationZone: str # The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone, targetDisk: str # The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/moveInstance\n@desc Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior).\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., destinationZone: str # The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone, targetInstance: str # The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions\n@desc Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}\n@desc Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.\n@required {region: str # Name of the region resource to return.}\n@returns(200) {creationTimestamp: str, deprecated: map{deleted: str, deprecated: str, obsolete: str, replacement: str, state: str}, description: str, id: str(uint64), kind: str, name: str, quotas: [map], selfLink: str, status: str, supportsPzs: bool, zones: [str]} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/addresses\n@desc Retrieves a list of addresses contained within the specified region.\n@required {region: str # Name of the region for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/addresses\n@desc Creates an address resource in the specified project by using the data included in the request.\n@required {region: str # Name of the region for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., address: str # The static IP address represented by this resource., addressType: str(EXTERNAL/INTERNAL/UNSPECIFIED_TYPE) # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this field when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., ipVersion: str(IPV4/IPV6/UNSPECIFIED_VERSION) # The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address., ipv6EndpointType: str(NETLB/VM) # The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation., kind: str=compute#address # [Output Only] Type of the resource. Always compute#address for addresses., name: str # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit., network: str # The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose., networkTier: str(FIXED_STANDARD/PREMIUM/STANDARD/STANDARD_OVERRIDES_FIXED_STANDARD) # This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM., prefixLength: int(int32) # The prefix length if the resource represents an IP range., purpose: str(DNS_RESOLVER/GCE_ENDPOINT/IPSEC_INTERCONNECT/NAT_AUTO/PRIVATE_SERVICE_CONNECT/SERVERLESS/SHARED_LOADBALANCER_VIP/VPC_PEERING) # The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose., region: str # [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.*, selfLink: str # [Output Only] Server-defined URL for the resource., status: str(IN_USE/RESERVED/RESERVING) # [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available., subnetwork: str # The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose., users: [str] # [Output Only] The URLs of the resources that are using this address.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/addresses/{address}\n@desc Deletes the specified address resource.\n@required {region: str # Name of the region for this request., address: str # Name of the address resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/addresses/{address}\n@desc Returns the specified address resource.\n@required {region: str # Name of the region for this request., address: str # Name of the address resource to return.}\n@returns(200) {address: str, addressType: str, creationTimestamp: str, description: str, id: str(uint64), ipVersion: str, ipv6EndpointType: str, kind: str, name: str, network: str, networkTier: str, prefixLength: int(int32), purpose: str, region: str, selfLink: str, status: str, subnetwork: str, users: [str]} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/addresses/{resource}/setLabels\n@desc Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation.\n@required {region: str # The region for this request., resource: str # Name or id of the resource for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint., labels: map # The labels to set for this resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/autoscalers\n@desc Retrieves a list of autoscalers contained within the specified region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/autoscalers\n@desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {region: str # Name of the region scoping this request.}\n@optional {autoscaler: str # Name of the autoscaler to patch., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoscalingPolicy: map{coolDownPeriodSec: int(int32), cpuUtilization: map, customMetricUtilizations: [map], loadBalancingUtilization: map, maxNumReplicas: int(int32), minNumReplicas: int(int32), mode: str, scaleInControl: map, scalingSchedules: map} # Cloud Autoscaler policy., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#autoscaler # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers., name: str # 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., recommendedSize: int(int32) # [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction., region: str # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope)., scalingScheduleStatus: map # [Output Only] Status information of existing scaling schedules., selfLink: str # [Output Only] Server-defined URL for the resource., status: str(ACTIVE/DELETING/ERROR/PENDING) # [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future., statusDetails: [map{message: str, type: str}] # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter., target: str # URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler., zone: str # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/autoscalers\n@desc Creates an autoscaler in the specified project using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoscalingPolicy: map{coolDownPeriodSec: int(int32), cpuUtilization: map, customMetricUtilizations: [map], loadBalancingUtilization: map, maxNumReplicas: int(int32), minNumReplicas: int(int32), mode: str, scaleInControl: map, scalingSchedules: map} # Cloud Autoscaler policy., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#autoscaler # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers., name: str # 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., recommendedSize: int(int32) # [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction., region: str # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope)., scalingScheduleStatus: map # [Output Only] Status information of existing scaling schedules., selfLink: str # [Output Only] Server-defined URL for the resource., status: str(ACTIVE/DELETING/ERROR/PENDING) # [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future., statusDetails: [map{message: str, type: str}] # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter., target: str # URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler., zone: str # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/regions/{region}/autoscalers\n@desc Updates an autoscaler in the specified project using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {autoscaler: str # Name of the autoscaler to update., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoscalingPolicy: map{coolDownPeriodSec: int(int32), cpuUtilization: map, customMetricUtilizations: [map], loadBalancingUtilization: map, maxNumReplicas: int(int32), minNumReplicas: int(int32), mode: str, scaleInControl: map, scalingSchedules: map} # Cloud Autoscaler policy., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#autoscaler # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers., name: str # 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., recommendedSize: int(int32) # [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction., region: str # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope)., scalingScheduleStatus: map # [Output Only] Status information of existing scaling schedules., selfLink: str # [Output Only] Server-defined URL for the resource., status: str(ACTIVE/DELETING/ERROR/PENDING) # [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future., statusDetails: [map{message: str, type: str}] # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter., target: str # URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler., zone: str # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/autoscalers/{autoscaler}\n@desc Deletes the specified autoscaler.\n@required {region: str # Name of the region scoping this request., autoscaler: str # Name of the autoscaler to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/autoscalers/{autoscaler}\n@desc Returns the specified autoscaler.\n@required {region: str # Name of the region scoping this request., autoscaler: str # Name of the autoscaler to return.}\n@returns(200) {autoscalingPolicy: map{coolDownPeriodSec: int(int32), cpuUtilization: map{predictiveMethod: str, utilizationTarget: num(double)}, customMetricUtilizations: [map], loadBalancingUtilization: map{utilizationTarget: num(double)}, maxNumReplicas: int(int32), minNumReplicas: int(int32), mode: str, scaleInControl: map{maxScaledInReplicas: map{calculated: int(int32), fixed: int(int32), percent: int(int32)}, timeWindowSec: int(int32)}, scalingSchedules: map}, creationTimestamp: str, description: str, id: str(uint64), kind: str, name: str, recommendedSize: int(int32), region: str, scalingScheduleStatus: map, selfLink: str, status: str, statusDetails: [map], target: str, zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/backendServices\n@desc Retrieves the list of regional BackendService resources available to the specified project in the given region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/backendServices\n@desc Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., affinityCookieTtlSec: int(int32) # Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true., backends: [map{balancingMode: str, capacityScaler: num(float), description: str, failover: bool, group: str, maxConnections: int(int32), maxConnectionsPerEndpoint: int(int32), maxConnectionsPerInstance: int(int32), maxRate: int(int32), maxRatePerEndpoint: num(float), maxRatePerInstance: num(float), maxUtilization: num(float)}] # The list of backends that serve this BackendService., cdnPolicy: map{bypassCacheOnRequestHeaders: [map], cacheKeyPolicy: map, cacheMode: str, clientTtl: int(int32), defaultTtl: int(int32), maxTtl: int(int32), negativeCaching: bool, negativeCachingPolicy: [map], requestCoalescing: bool, serveWhileStale: int(int32), signedUrlCacheMaxAgeSec: str(int64), signedUrlKeyNames: [str]} # Message containing Cloud CDN configuration for a backend service., circuitBreakers: map{maxConnections: int(int32), maxPendingRequests: int(int32), maxRequests: int(int32), maxRequestsPerConnection: int(int32), maxRetries: int(int32)} # Settings controlling the volume of requests, connections and retries to this backend service., compressionMode: str(AUTOMATIC/DISABLED) # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header., connectionDraining: map{drainingTimeoutSec: int(int32)} # Message containing connection draining configuration., connectionTrackingPolicy: map{connectionPersistenceOnUnhealthyBackends: str, enableStrongAffinity: bool, idleTimeoutSec: int(int32), trackingMode: str} # Connection Tracking configuration for this BackendService., consistentHash: map{httpCookie: map, httpHeaderName: str, minimumRingSize: str(int64)} # This message defines settings for a consistent hash style load balancer., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customRequestHeaders: [str] # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)., customResponseHeaders: [str] # Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)., description: str # An optional description of this resource. Provide this property when you create the resource., edgeSecurityPolicy: str # [Output Only] The resource URL for the edge security policy associated with this backend service., enableCDN: bool # If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer., failoverPolicy: map{disableConnectionDrainOnFailover: bool, dropTrafficIfUnhealthy: bool, failoverRatio: num(float)} # For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes)., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService., healthChecks: [str] # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check., iap: map{enabled: bool, oauth2ClientId: str, oauth2ClientSecret: str, oauth2ClientSecretSha256: str} # Identity-Aware Proxy, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#backendService # [Output Only] Type of resource. Always compute#backendService for backend services., loadBalancingScheme: str(EXTERNAL/EXTERNAL_MANAGED/INTERNAL/INTERNAL_MANAGED/INTERNAL_SELF_MANAGED/INVALID_LOAD_BALANCING_SCHEME) # Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer., localityLbPolicies: [map{customPolicy: map, policy: map}] # A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration., localityLbPolicy: str(INVALID_LB_POLICY/LEAST_REQUEST/MAGLEV/ORIGINAL_DESTINATION/RANDOM/RING_HASH/ROUND_ROBIN/WEIGHTED_MAGLEV) # The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true., logConfig: map{enable: bool, optionalFields: [str], optionalMode: str, sampleRate: num(float)} # The available logging options for the load balancer traffic served by this backend service., maxStreamDuration: map{nanos: int(int32), seconds: str(int64)} # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". Range is approximately 10,000 years., name: str # 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., network: str # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL., outlierDetection: map{baseEjectionTime: map, consecutiveErrors: int(int32), consecutiveGatewayFailure: int(int32), enforcingConsecutiveErrors: int(int32), enforcingConsecutiveGatewayFailure: int(int32), enforcingSuccessRate: int(int32), interval: map, maxEjectionPercent: int(int32), successRateMinimumHosts: int(int32), successRateRequestVolume: int(int32), successRateStdevFactor: int(int32)} # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service., port: int(int32) # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port., portName: str # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name., protocol: str(GRPC/HTTP/HTTP2/HTTPS/SSL/TCP/UDP/UNSPECIFIED) # The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy., region: str # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., securityPolicy: str # [Output Only] The resource URL for the security policy associated with this backend service., securitySettings: map{clientTlsPolicy: str, subjectAltNames: [str]} # The authentication and authorization settings for a BackendService., selfLink: str # [Output Only] Server-defined URL for the resource., serviceBindings: [str] # URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty., sessionAffinity: str(CLIENT_IP/CLIENT_IP_NO_DESTINATION/CLIENT_IP_PORT_PROTO/CLIENT_IP_PROTO/GENERATED_COOKIE/HEADER_FIELD/HTTP_COOKIE/NONE) # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity)., subsetting: map{policy: str} # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director., timeoutSec: int(int32) # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/backendServices/{backendService}\n@desc Deletes the specified regional BackendService resource.\n@required {region: str # Name of the region scoping this request., backendService: str # Name of the BackendService resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/backendServices/{backendService}\n@desc Returns the specified regional BackendService resource.\n@required {region: str # Name of the region scoping this request., backendService: str # Name of the BackendService resource to return.}\n@returns(200) {affinityCookieTtlSec: int(int32), backends: [map], cdnPolicy: map{bypassCacheOnRequestHeaders: [map], cacheKeyPolicy: map{includeHost: bool, includeHttpHeaders: [str], includeNamedCookies: [str], includeProtocol: bool, includeQueryString: bool, queryStringBlacklist: [str], queryStringWhitelist: [str]}, cacheMode: str, clientTtl: int(int32), defaultTtl: int(int32), maxTtl: int(int32), negativeCaching: bool, negativeCachingPolicy: [map], requestCoalescing: bool, serveWhileStale: int(int32), signedUrlCacheMaxAgeSec: str(int64), signedUrlKeyNames: [str]}, circuitBreakers: map{maxConnections: int(int32), maxPendingRequests: int(int32), maxRequests: int(int32), maxRequestsPerConnection: int(int32), maxRetries: int(int32)}, compressionMode: str, connectionDraining: map{drainingTimeoutSec: int(int32)}, connectionTrackingPolicy: map{connectionPersistenceOnUnhealthyBackends: str, enableStrongAffinity: bool, idleTimeoutSec: int(int32), trackingMode: str}, consistentHash: map{httpCookie: map{name: str, path: str, ttl: map{nanos: int(int32), seconds: str(int64)}}, httpHeaderName: str, minimumRingSize: str(int64)}, creationTimestamp: str, customRequestHeaders: [str], customResponseHeaders: [str], description: str, edgeSecurityPolicy: str, enableCDN: bool, failoverPolicy: map{disableConnectionDrainOnFailover: bool, dropTrafficIfUnhealthy: bool, failoverRatio: num(float)}, fingerprint: str(byte), healthChecks: [str], iap: map{enabled: bool, oauth2ClientId: str, oauth2ClientSecret: str, oauth2ClientSecretSha256: str}, id: str(uint64), kind: str, loadBalancingScheme: str, localityLbPolicies: [map], localityLbPolicy: str, logConfig: map{enable: bool, optionalFields: [str], optionalMode: str, sampleRate: num(float)}, maxStreamDuration: map{nanos: int(int32), seconds: str(int64)}, name: str, network: str, outlierDetection: map{baseEjectionTime: map{nanos: int(int32), seconds: str(int64)}, consecutiveErrors: int(int32), consecutiveGatewayFailure: int(int32), enforcingConsecutiveErrors: int(int32), enforcingConsecutiveGatewayFailure: int(int32), enforcingSuccessRate: int(int32), interval: map{nanos: int(int32), seconds: str(int64)}, maxEjectionPercent: int(int32), successRateMinimumHosts: int(int32), successRateRequestVolume: int(int32), successRateStdevFactor: int(int32)}, port: int(int32), portName: str, protocol: str, region: str, securityPolicy: str, securitySettings: map{clientTlsPolicy: str, subjectAltNames: [str]}, selfLink: str, serviceBindings: [str], sessionAffinity: str, subsetting: map{policy: str}, timeoutSec: int(int32)} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/backendServices/{backendService}\n@desc Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {region: str # Name of the region scoping this request., backendService: str # Name of the BackendService resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., affinityCookieTtlSec: int(int32) # Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true., backends: [map{balancingMode: str, capacityScaler: num(float), description: str, failover: bool, group: str, maxConnections: int(int32), maxConnectionsPerEndpoint: int(int32), maxConnectionsPerInstance: int(int32), maxRate: int(int32), maxRatePerEndpoint: num(float), maxRatePerInstance: num(float), maxUtilization: num(float)}] # The list of backends that serve this BackendService., cdnPolicy: map{bypassCacheOnRequestHeaders: [map], cacheKeyPolicy: map, cacheMode: str, clientTtl: int(int32), defaultTtl: int(int32), maxTtl: int(int32), negativeCaching: bool, negativeCachingPolicy: [map], requestCoalescing: bool, serveWhileStale: int(int32), signedUrlCacheMaxAgeSec: str(int64), signedUrlKeyNames: [str]} # Message containing Cloud CDN configuration for a backend service., circuitBreakers: map{maxConnections: int(int32), maxPendingRequests: int(int32), maxRequests: int(int32), maxRequestsPerConnection: int(int32), maxRetries: int(int32)} # Settings controlling the volume of requests, connections and retries to this backend service., compressionMode: str(AUTOMATIC/DISABLED) # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header., connectionDraining: map{drainingTimeoutSec: int(int32)} # Message containing connection draining configuration., connectionTrackingPolicy: map{connectionPersistenceOnUnhealthyBackends: str, enableStrongAffinity: bool, idleTimeoutSec: int(int32), trackingMode: str} # Connection Tracking configuration for this BackendService., consistentHash: map{httpCookie: map, httpHeaderName: str, minimumRingSize: str(int64)} # This message defines settings for a consistent hash style load balancer., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customRequestHeaders: [str] # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)., customResponseHeaders: [str] # Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)., description: str # An optional description of this resource. Provide this property when you create the resource., edgeSecurityPolicy: str # [Output Only] The resource URL for the edge security policy associated with this backend service., enableCDN: bool # If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer., failoverPolicy: map{disableConnectionDrainOnFailover: bool, dropTrafficIfUnhealthy: bool, failoverRatio: num(float)} # For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes)., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService., healthChecks: [str] # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check., iap: map{enabled: bool, oauth2ClientId: str, oauth2ClientSecret: str, oauth2ClientSecretSha256: str} # Identity-Aware Proxy, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#backendService # [Output Only] Type of resource. Always compute#backendService for backend services., loadBalancingScheme: str(EXTERNAL/EXTERNAL_MANAGED/INTERNAL/INTERNAL_MANAGED/INTERNAL_SELF_MANAGED/INVALID_LOAD_BALANCING_SCHEME) # Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer., localityLbPolicies: [map{customPolicy: map, policy: map}] # A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration., localityLbPolicy: str(INVALID_LB_POLICY/LEAST_REQUEST/MAGLEV/ORIGINAL_DESTINATION/RANDOM/RING_HASH/ROUND_ROBIN/WEIGHTED_MAGLEV) # The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true., logConfig: map{enable: bool, optionalFields: [str], optionalMode: str, sampleRate: num(float)} # The available logging options for the load balancer traffic served by this backend service., maxStreamDuration: map{nanos: int(int32), seconds: str(int64)} # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". Range is approximately 10,000 years., name: str # 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., network: str # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL., outlierDetection: map{baseEjectionTime: map, consecutiveErrors: int(int32), consecutiveGatewayFailure: int(int32), enforcingConsecutiveErrors: int(int32), enforcingConsecutiveGatewayFailure: int(int32), enforcingSuccessRate: int(int32), interval: map, maxEjectionPercent: int(int32), successRateMinimumHosts: int(int32), successRateRequestVolume: int(int32), successRateStdevFactor: int(int32)} # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service., port: int(int32) # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port., portName: str # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name., protocol: str(GRPC/HTTP/HTTP2/HTTPS/SSL/TCP/UDP/UNSPECIFIED) # The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy., region: str # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., securityPolicy: str # [Output Only] The resource URL for the security policy associated with this backend service., securitySettings: map{clientTlsPolicy: str, subjectAltNames: [str]} # The authentication and authorization settings for a BackendService., selfLink: str # [Output Only] Server-defined URL for the resource., serviceBindings: [str] # URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty., sessionAffinity: str(CLIENT_IP/CLIENT_IP_NO_DESTINATION/CLIENT_IP_PORT_PROTO/CLIENT_IP_PROTO/GENERATED_COOKIE/HEADER_FIELD/HTTP_COOKIE/NONE) # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity)., subsetting: map{policy: str} # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director., timeoutSec: int(int32) # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/regions/{region}/backendServices/{backendService}\n@desc Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview .\n@required {region: str # Name of the region scoping this request., backendService: str # Name of the BackendService resource to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., affinityCookieTtlSec: int(int32) # Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true., backends: [map{balancingMode: str, capacityScaler: num(float), description: str, failover: bool, group: str, maxConnections: int(int32), maxConnectionsPerEndpoint: int(int32), maxConnectionsPerInstance: int(int32), maxRate: int(int32), maxRatePerEndpoint: num(float), maxRatePerInstance: num(float), maxUtilization: num(float)}] # The list of backends that serve this BackendService., cdnPolicy: map{bypassCacheOnRequestHeaders: [map], cacheKeyPolicy: map, cacheMode: str, clientTtl: int(int32), defaultTtl: int(int32), maxTtl: int(int32), negativeCaching: bool, negativeCachingPolicy: [map], requestCoalescing: bool, serveWhileStale: int(int32), signedUrlCacheMaxAgeSec: str(int64), signedUrlKeyNames: [str]} # Message containing Cloud CDN configuration for a backend service., circuitBreakers: map{maxConnections: int(int32), maxPendingRequests: int(int32), maxRequests: int(int32), maxRequestsPerConnection: int(int32), maxRetries: int(int32)} # Settings controlling the volume of requests, connections and retries to this backend service., compressionMode: str(AUTOMATIC/DISABLED) # Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header., connectionDraining: map{drainingTimeoutSec: int(int32)} # Message containing connection draining configuration., connectionTrackingPolicy: map{connectionPersistenceOnUnhealthyBackends: str, enableStrongAffinity: bool, idleTimeoutSec: int(int32), trackingMode: str} # Connection Tracking configuration for this BackendService., consistentHash: map{httpCookie: map, httpHeaderName: str, minimumRingSize: str(int64)} # This message defines settings for a consistent hash style load balancer., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customRequestHeaders: [str] # Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)., customResponseHeaders: [str] # Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers)., description: str # An optional description of this resource. Provide this property when you create the resource., edgeSecurityPolicy: str # [Output Only] The resource URL for the edge security policy associated with this backend service., enableCDN: bool # If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer., failoverPolicy: map{disableConnectionDrainOnFailover: bool, dropTrafficIfUnhealthy: bool, failoverRatio: num(float)} # For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes)., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService., healthChecks: [str] # The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check., iap: map{enabled: bool, oauth2ClientId: str, oauth2ClientSecret: str, oauth2ClientSecretSha256: str} # Identity-Aware Proxy, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#backendService # [Output Only] Type of resource. Always compute#backendService for backend services., loadBalancingScheme: str(EXTERNAL/EXTERNAL_MANAGED/INTERNAL/INTERNAL_MANAGED/INTERNAL_SELF_MANAGED/INVALID_LOAD_BALANCING_SCHEME) # Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer., localityLbPolicies: [map{customPolicy: map, policy: map}] # A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration., localityLbPolicy: str(INVALID_LB_POLICY/LEAST_REQUEST/MAGLEV/ORIGINAL_DESTINATION/RANDOM/RING_HASH/ROUND_ROBIN/WEIGHTED_MAGLEV) # The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true., logConfig: map{enable: bool, optionalFields: [str], optionalMode: str, sampleRate: num(float)} # The available logging options for the load balancer traffic served by this backend service., maxStreamDuration: map{nanos: int(int32), seconds: str(int64)} # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". Range is approximately 10,000 years., name: str # 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., network: str # The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL., outlierDetection: map{baseEjectionTime: map, consecutiveErrors: int(int32), consecutiveGatewayFailure: int(int32), enforcingConsecutiveErrors: int(int32), enforcingConsecutiveGatewayFailure: int(int32), enforcingSuccessRate: int(int32), interval: map, maxEjectionPercent: int(int32), successRateMinimumHosts: int(int32), successRateRequestVolume: int(int32), successRateStdevFactor: int(int32)} # Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service., port: int(int32) # Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port., portName: str # A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name., protocol: str(GRPC/HTTP/HTTP2/HTTPS/SSL/TCP/UDP/UNSPECIFIED) # The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy., region: str # [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., securityPolicy: str # [Output Only] The resource URL for the security policy associated with this backend service., securitySettings: map{clientTlsPolicy: str, subjectAltNames: [str]} # The authentication and authorization settings for a BackendService., selfLink: str # [Output Only] Server-defined URL for the resource., serviceBindings: [str] # URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty., sessionAffinity: str(CLIENT_IP/CLIENT_IP_NO_DESTINATION/CLIENT_IP_PORT_PROTO/CLIENT_IP_PROTO/GENERATED_COOKIE/HEADER_FIELD/HTTP_COOKIE/NONE) # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity)., subsetting: map{policy: str} # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director., timeoutSec: int(int32) # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/backendServices/{backendService}/getHealth\n@desc Gets the most recent health check results for this regional BackendService.\n@required {region: str # Name of the region scoping this request., backendService: str # Name of the BackendService resource for which to get health.}\n@optional {group: str # A URI referencing one of the instance groups or network endpoint groups listed in the backend service.}\n@returns(200) {annotations: map, healthStatus: [map], kind: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/commitments\n@desc Retrieves a list of commitments contained within the specified region.\n@required {region: str # Name of the region for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/commitments\n@desc Creates a commitment in the specified project using the data included in the request.\n@required {region: str # Name of the region for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoRenew: bool # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment., category: str(CATEGORY_UNSPECIFIED/LICENSE/MACHINE) # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., endTimestamp: str # [Output Only] Commitment end time in RFC3339 text format., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#commitment # [Output Only] Type of the resource. Always compute#commitment for commitments., licenseResource: map{amount: str(int64), coresPerLicense: str, license: str} # Commitment for a particular license resource., mergeSourceCommitments: [str] # List of source commitments to be merged into a new commitment., name: str # 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., plan: str(INVALID/THIRTY_SIX_MONTH/TWELVE_MONTH) # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years)., region: str # [Output Only] URL of the region where this commitment may be used., reservations: [map{commitment: str, creationTimestamp: str, description: str, id: str(uint64), kind: str, name: str, resourcePolicies: map, resourceStatus: map, satisfiesPzs: bool, selfLink: str, shareSettings: map, specificReservation: map, specificReservationRequired: bool, status: str, zone: str}] # List of reservations in this commitment., resources: [map{acceleratorType: str, amount: str(int64), type: str}] # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together., selfLink: str # [Output Only] Server-defined URL for the resource., splitSourceCommitment: str # Source commitment to be splitted into a new commitment., startTimestamp: str # [Output Only] Commitment start time in RFC3339 text format., status: str(ACTIVE/CANCELLED/CREATING/EXPIRED/NOT_YET_ACTIVE) # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED., statusMessage: str # [Output Only] An optional, human-readable explanation of the status., type: str(ACCELERATOR_OPTIMIZED/COMPUTE_OPTIMIZED/COMPUTE_OPTIMIZED_C2D/COMPUTE_OPTIMIZED_C3/GENERAL_PURPOSE/GENERAL_PURPOSE_E2/GENERAL_PURPOSE_N2/GENERAL_PURPOSE_N2D/GENERAL_PURPOSE_T2D/MEMORY_OPTIMIZED/MEMORY_OPTIMIZED_M3/TYPE_UNSPECIFIED) # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/commitments/{commitment}\n@desc Returns the specified commitment resource.\n@required {region: str # Name of the region for this request., commitment: str # Name of the commitment to return.}\n@returns(200) {autoRenew: bool, category: str, creationTimestamp: str, description: str, endTimestamp: str, id: str(uint64), kind: str, licenseResource: map{amount: str(int64), coresPerLicense: str, license: str}, mergeSourceCommitments: [str], name: str, plan: str, region: str, reservations: [map], resources: [map], selfLink: str, splitSourceCommitment: str, startTimestamp: str, status: str, statusMessage: str, type: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/commitments/{commitment}\n@desc Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.\n@required {region: str # Name of the region for this request., commitment: str # Name of the commitment for which auto renew is being updated.}\n@optional {paths: [str], requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., updateMask: str # update_mask indicates fields to be updated as part of this request., autoRenew: bool # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment., category: str(CATEGORY_UNSPECIFIED/LICENSE/MACHINE) # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., endTimestamp: str # [Output Only] Commitment end time in RFC3339 text format., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#commitment # [Output Only] Type of the resource. Always compute#commitment for commitments., licenseResource: map{amount: str(int64), coresPerLicense: str, license: str} # Commitment for a particular license resource., mergeSourceCommitments: [str] # List of source commitments to be merged into a new commitment., name: str # 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., plan: str(INVALID/THIRTY_SIX_MONTH/TWELVE_MONTH) # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years)., region: str # [Output Only] URL of the region where this commitment may be used., reservations: [map{commitment: str, creationTimestamp: str, description: str, id: str(uint64), kind: str, name: str, resourcePolicies: map, resourceStatus: map, satisfiesPzs: bool, selfLink: str, shareSettings: map, specificReservation: map, specificReservationRequired: bool, status: str, zone: str}] # List of reservations in this commitment., resources: [map{acceleratorType: str, amount: str(int64), type: str}] # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together., selfLink: str # [Output Only] Server-defined URL for the resource., splitSourceCommitment: str # Source commitment to be splitted into a new commitment., startTimestamp: str # [Output Only] Commitment start time in RFC3339 text format., status: str(ACTIVE/CANCELLED/CREATING/EXPIRED/NOT_YET_ACTIVE) # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED., statusMessage: str # [Output Only] An optional, human-readable explanation of the status., type: str(ACCELERATOR_OPTIMIZED/COMPUTE_OPTIMIZED/COMPUTE_OPTIMIZED_C2D/COMPUTE_OPTIMIZED_C3/GENERAL_PURPOSE/GENERAL_PURPOSE_E2/GENERAL_PURPOSE_N2/GENERAL_PURPOSE_N2D/GENERAL_PURPOSE_T2D/MEMORY_OPTIMIZED/MEMORY_OPTIMIZED_M3/TYPE_UNSPECIFIED) # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/diskTypes\n@desc Retrieves a list of regional disk types available to the specified project.\n@required {region: str # The name of the region for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/diskTypes/{diskType}\n@desc Returns the specified regional disk type.\n@required {region: str # The name of the region for this request., diskType: str # Name of the disk type to return.}\n@returns(200) {creationTimestamp: str, defaultDiskSizeGb: str(int64), deprecated: map{deleted: str, deprecated: str, obsolete: str, replacement: str, state: str}, description: str, id: str(uint64), kind: str, name: str, region: str, selfLink: str, validDiskSize: str, zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/disks\n@desc Retrieves the list of persistent disks contained within the specified region.\n@required {region: str # Name of the region for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/disks\n@desc Creates a persistent regional disk in the specified project using the data included in the request.\n@required {region: str # Name of the region for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sourceImage: str # Source image to restore onto a disk. This field is optional., architecture: str(ARCHITECTURE_UNSPECIFIED/ARM64/X86_64) # The architecture of the disk. Valid values are ARM64 or X86_64., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., diskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, guestOsFeatures: [map{type: str}] # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#disk # [Output Only] Type of the resource. Always compute#disk for disks., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk., labels: map # Labels to apply to this disk. These can be later modified by the setLabels method., lastAttachTimestamp: str # [Output Only] Last attach timestamp in RFC3339 text format., lastDetachTimestamp: str # [Output Only] Last detach timestamp in RFC3339 text format., licenseCodes: [str(int64)] # Integer license codes indicating which licenses are attached to this disk., licenses: [str] # A list of publicly visible licenses. Reserved for Google's use., locationHint: str # An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API., name: str # 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., options: str # Internal use only., params: map{resourceManagerTags: map} # Additional disk params., physicalBlockSizeBytes: str(int64) # Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project., provisionedIops: str(int64) # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation., region: str # [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., replicaZones: [str] # URLs of the zones where the disk should be replicated to. Only applicable for regional resources., resourcePolicies: [str] # Resource policies applied to this disk for automatic snapshot creations., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined fully-qualified URL for this resource., sizeGb: str(int64) # Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive., sourceDisk: str # The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk, sourceDiskId: str # [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used., sourceImage: str # The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family, sourceImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceImageId: str # [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: str # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot, sourceSnapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceSnapshotId: str # [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., sourceStorageObject: str # The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead., status: str(CREATING/DELETING/FAILED/READY/RESTORING) # [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting., type: str # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types., users: [str] # [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance, zone: str # [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/disks/{disk}\n@desc Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.\n@required {region: str # Name of the region for this request., disk: str # Name of the regional persistent disk to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/disks/{disk}\n@desc Returns a specified regional persistent disk.\n@required {region: str # Name of the region for this request., disk: str # Name of the regional persistent disk to return.}\n@returns(200) {architecture: str, creationTimestamp: str, description: str, diskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, guestOsFeatures: [map], id: str(uint64), kind: str, labelFingerprint: str(byte), labels: map, lastAttachTimestamp: str, lastDetachTimestamp: str, licenseCodes: [str(int64)], licenses: [str], locationHint: str, name: str, options: str, params: map{resourceManagerTags: map}, physicalBlockSizeBytes: str(int64), provisionedIops: str(int64), region: str, replicaZones: [str], resourcePolicies: [str], satisfiesPzs: bool, selfLink: str, sizeGb: str(int64), sourceDisk: str, sourceDiskId: str, sourceImage: str, sourceImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceImageId: str, sourceSnapshot: str, sourceSnapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceSnapshotId: str, sourceStorageObject: str, status: str, type: str, users: [str], zone: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/disks/{disk}\n@desc Update the specified disk with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.\n@required {region: str # The name of the region for this request., disk: str # The disk name for this request.}\n@optional {paths: [str], requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., updateMask: str # update_mask indicates fields to be updated as part of this request., architecture: str(ARCHITECTURE_UNSPECIFIED/ARM64/X86_64) # The architecture of the disk. Valid values are ARM64 or X86_64., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., diskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, guestOsFeatures: [map{type: str}] # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#disk # [Output Only] Type of the resource. Always compute#disk for disks., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk., labels: map # Labels to apply to this disk. These can be later modified by the setLabels method., lastAttachTimestamp: str # [Output Only] Last attach timestamp in RFC3339 text format., lastDetachTimestamp: str # [Output Only] Last detach timestamp in RFC3339 text format., licenseCodes: [str(int64)] # Integer license codes indicating which licenses are attached to this disk., licenses: [str] # A list of publicly visible licenses. Reserved for Google's use., locationHint: str # An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API., name: str # 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., options: str # Internal use only., params: map{resourceManagerTags: map} # Additional disk params., physicalBlockSizeBytes: str(int64) # Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project., provisionedIops: str(int64) # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation., region: str # [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., replicaZones: [str] # URLs of the zones where the disk should be replicated to. Only applicable for regional resources., resourcePolicies: [str] # Resource policies applied to this disk for automatic snapshot creations., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined fully-qualified URL for this resource., sizeGb: str(int64) # Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive., sourceDisk: str # The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk, sourceDiskId: str # [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used., sourceImage: str # The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family, sourceImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceImageId: str # [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: str # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot, sourceSnapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceSnapshotId: str # [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., sourceStorageObject: str # The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead., status: str(CREATING/DELETING/FAILED/READY/RESTORING) # [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting., type: str # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types., users: [str] # [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance, zone: str # [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies\n@desc Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.\n@required {region: str # The name of the region for this request., disk: str # The disk name for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., resourcePolicies: [str] # Resource policies to be added to this disk.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/disks/{disk}/createSnapshot\n@desc Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.\n@required {region: str # Name of the region for this request., disk: str # Name of the regional persistent disk to snapshot.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., architecture: str(ARCHITECTURE_UNSPECIFIED/ARM64/X86_64) # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64., autoCreated: bool # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk., chainName: str # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value., creationSizeBytes: str(int64) # [Output Only] Size in bytes of the snapshot at creation time., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., diskSizeGb: str(int64) # [Output Only] Size of the source disk, specified in GB., downloadBytes: str(int64) # [Output Only] Number of bytes downloaded to restore a snapshot to a disk., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#snapshot # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot., labels: map # Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty., licenseCodes: [str(int64)] # [Output Only] Integer license codes indicating which licenses are attached to this snapshot., licenses: [str] # [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)., locationHint: str # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API., name: str # 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., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined URL for the resource., snapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, snapshotType: str(ARCHIVE/STANDARD) # Indicates the type of the snapshot., sourceDisk: str # The source disk used to create this snapshot., sourceDiskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceDiskId: str # [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., sourceSnapshotSchedulePolicy: str # [Output Only] URL of the resource policy which created this scheduled snapshot., sourceSnapshotSchedulePolicyId: str # [Output Only] ID of the resource policy which created this scheduled snapshot., status: str(CREATING/DELETING/FAILED/READY/UPLOADING) # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING., storageBytes: str(int64) # [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion., storageBytesStatus: str(UPDATING/UP_TO_DATE) # [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., storageLocations: [str] # Cloud Storage bucket storage location of the snapshot (regional or multi-regional).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies\n@desc Removes resource policies from a regional disk.\n@required {region: str # The name of the region for this request., disk: str # The disk name for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., resourcePolicies: [str] # Resource policies to be removed from this disk.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/disks/{disk}/resize\n@desc Resizes the specified regional persistent disk.\n@required {region: str # Name of the region for this request., disk: str # Name of the regional persistent disk.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sizeGb: str(int64) # The new size of the regional persistent disk, which is specified in GB.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/disks/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/disks/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/disks/{resource}/setLabels\n@desc Sets the labels on the target regional disk.\n@required {region: str # The region for this request., resource: str # Name or id of the resource for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint., labels: map # The labels to set for this resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/disks/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/firewallPolicies\n@desc Lists all the network firewall policies that have been configured for the specified project in the given region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/firewallPolicies\n@desc Creates a new network firewall policy in the specified project and region.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., associations: [map{attachmentTarget: str, displayName: str, firewallPolicyId: str, name: str, shortName: str}] # A list of associations that belong to this firewall policy., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., displayName: str # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., fingerprint: str(byte) # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#firewallPolicy # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies, name: str # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy., parent: str # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies., region: str # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., ruleTupleCount: int(int32) # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples., rules: [map{action: str, description: str, direction: str, disabled: bool, enableLogging: bool, kind: str, match: map, priority: int(int32), ruleName: str, ruleTupleCount: int(int32), targetResources: [str], targetSecureTags: [map], targetServiceAccounts: [str]}] # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match \"*\"). If no rules are provided when creating a firewall policy, a default rule with action \"allow\" will be added., selfLink: str # [Output Only] Server-defined URL for the resource., selfLinkWithId: str # [Output Only] Server-defined URL for this resource with the resource id., shortName: str # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls\n@desc Returns the effective firewalls on a given network.\n@required {region: str # Name of the region scoping this request., network: str # Network reference}\n@returns(200) {firewallPolicys: [map], firewalls: [map]} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}\n@desc Deletes the specified network firewall policy.\n@required {region: str # Name of the region scoping this request., firewallPolicy: str # Name of the firewall policy to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}\n@desc Returns the specified network firewall policy.\n@required {region: str # Name of the region scoping this request., firewallPolicy: str # Name of the firewall policy to get.}\n@returns(200) {associations: [map], creationTimestamp: str, description: str, displayName: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, parent: str, region: str, ruleTupleCount: int(int32), rules: [map], selfLink: str, selfLinkWithId: str, shortName: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}\n@desc Patches the specified network firewall policy.\n@required {region: str # Name of the region scoping this request., firewallPolicy: str # Name of the firewall policy to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., associations: [map{attachmentTarget: str, displayName: str, firewallPolicyId: str, name: str, shortName: str}] # A list of associations that belong to this firewall policy., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., displayName: str # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., fingerprint: str(byte) # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#firewallPolicy # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies, name: str # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy., parent: str # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies., region: str # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., ruleTupleCount: int(int32) # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples., rules: [map{action: str, description: str, direction: str, disabled: bool, enableLogging: bool, kind: str, match: map, priority: int(int32), ruleName: str, ruleTupleCount: int(int32), targetResources: [str], targetSecureTags: [map], targetServiceAccounts: [str]}] # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match \"*\"). If no rules are provided when creating a firewall policy, a default rule with action \"allow\" will be added., selfLink: str # [Output Only] Server-defined URL for the resource., selfLinkWithId: str # [Output Only] Server-defined URL for this resource with the resource id., shortName: str # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation\n@desc Inserts an association for the specified network firewall policy.\n@required {region: str # Name of the region scoping this request., firewallPolicy: str # Name of the firewall policy to update.}\n@optional {replaceExistingAssociation: bool # Indicates whether or not to replace it if an association already exists. This is false by default, in which case an error will be returned if an association already exists., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., attachmentTarget: str # The target that the firewall policy is attached to., displayName: str # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association., firewallPolicyId: str # [Output Only] The firewall policy ID of the association., name: str # The name for an association., shortName: str # [Output Only] The short name of the firewall policy of the association.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule\n@desc Inserts a rule into a network firewall policy.\n@required {region: str # Name of the region scoping this request., firewallPolicy: str # Name of the firewall policy to update.}\n@optional {maxPriority: int # When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority., minPriority: int # When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., action: str # The Action to perform when the client connection triggers the rule. Valid actions are \"allow\", \"deny\" and \"goto_next\"., description: str # An optional description for this resource., direction: str(EGRESS/INGRESS) # The direction in which this rule applies., disabled: bool # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled., enableLogging: bool # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules., kind: str=compute#firewallPolicyRule # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules, match: map{destAddressGroups: [str], destFqdns: [str], destIpRanges: [str], destRegionCodes: [str], destThreatIntelligences: [str], layer4Configs: [map], srcAddressGroups: [str], srcFqdns: [str], srcIpRanges: [str], srcRegionCodes: [str], srcSecureTags: [map], srcThreatIntelligences: [str]} # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified., priority: int(int32) # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority., ruleName: str # An optional name for the rule. This field is not a unique identifier and can be updated., ruleTupleCount: int(int32) # [Output Only] Calculation of the complexity of a single firewall policy rule., targetResources: [str] # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule., targetSecureTags: [map{name: str, state: str}] # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256., targetServiceAccounts: [str] # A list of service accounts indicating the sets of instances that are applied with this rule.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules\n@desc Copies rules to the specified network firewall policy.\n@required {region: str # Name of the region scoping this request., firewallPolicy: str # Name of the firewall policy to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sourceFirewallPolicy: str # The firewall policy from which to copy rules.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation\n@desc Gets an association with the specified name.\n@required {region: str # Name of the region scoping this request., firewallPolicy: str # Name of the firewall policy to which the queried association belongs.}\n@optional {name: str # The name of the association to get from the firewall policy.}\n@returns(200) {attachmentTarget: str, displayName: str, firewallPolicyId: str, name: str, shortName: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule\n@desc Gets a rule of the specified priority.\n@required {region: str # Name of the region scoping this request., firewallPolicy: str # Name of the firewall policy to which the queried rule belongs.}\n@optional {priority: int # The priority of the rule to get from the firewall policy.}\n@returns(200) {action: str, description: str, direction: str, disabled: bool, enableLogging: bool, kind: str, match: map{destAddressGroups: [str], destFqdns: [str], destIpRanges: [str], destRegionCodes: [str], destThreatIntelligences: [str], layer4Configs: [map], srcAddressGroups: [str], srcFqdns: [str], srcIpRanges: [str], srcRegionCodes: [str], srcSecureTags: [map], srcThreatIntelligences: [str]}, priority: int(int32), ruleName: str, ruleTupleCount: int(int32), targetResources: [str], targetSecureTags: [map], targetServiceAccounts: [str]} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule\n@desc Patches a rule of the specified priority.\n@required {region: str # Name of the region scoping this request., firewallPolicy: str # Name of the firewall policy to update.}\n@optional {priority: int # The priority of the rule to patch., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., action: str # The Action to perform when the client connection triggers the rule. Valid actions are \"allow\", \"deny\" and \"goto_next\"., description: str # An optional description for this resource., direction: str(EGRESS/INGRESS) # The direction in which this rule applies., disabled: bool # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled., enableLogging: bool # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules., kind: str=compute#firewallPolicyRule # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules, match: map{destAddressGroups: [str], destFqdns: [str], destIpRanges: [str], destRegionCodes: [str], destThreatIntelligences: [str], layer4Configs: [map], srcAddressGroups: [str], srcFqdns: [str], srcIpRanges: [str], srcRegionCodes: [str], srcSecureTags: [map], srcThreatIntelligences: [str]} # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified., priority: int(int32) # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority., ruleName: str # An optional name for the rule. This field is not a unique identifier and can be updated., ruleTupleCount: int(int32) # [Output Only] Calculation of the complexity of a single firewall policy rule., targetResources: [str] # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule., targetSecureTags: [map{name: str, state: str}] # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256., targetServiceAccounts: [str] # A list of service accounts indicating the sets of instances that are applied with this rule.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation\n@desc Removes an association for the specified network firewall policy.\n@required {region: str # Name of the region scoping this request., firewallPolicy: str # Name of the firewall policy to update.}\n@optional {name: str # Name for the association that will be removed., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule\n@desc Deletes a rule of the specified priority.\n@required {region: str # Name of the region scoping this request., firewallPolicy: str # Name of the firewall policy to update.}\n@optional {priority: int # The priority of the rule to remove from the firewall policy., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/forwardingRules\n@desc Retrieves a list of ForwardingRule resources available to the specified project and region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/forwardingRules\n@desc Creates a ForwardingRule resource in the specified project and region using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., IPAddress: str # IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number., IPProtocol: str(AH/ESP/ICMP/L3_DEFAULT/SCTP/TCP/UDP) # The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends)., allPorts: bool # This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive., allowGlobalAccess: bool # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer., allowPscGlobalAccess: bool # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region., backendService: str # Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types., baseForwardingRule: str # [Output Only] The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., ipVersion: str(IPV4/IPV6/UNSPECIFIED_VERSION) # The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6., isMirroringCollector: bool # Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL., kind: str=compute#forwardingRule # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule., labels: map # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty., loadBalancingScheme: str(EXTERNAL/EXTERNAL_MANAGED/INTERNAL/INTERNAL_MANAGED/INTERNAL_SELF_MANAGED/INVALID) # Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts., metadataFilters: [map{filterLabels: [map], filterMatchCriteria: str}] # Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED., name: str # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter., network: str # This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided., networkTier: str(FIXED_STANDARD/PREMIUM/STANDARD/STANDARD_OVERRIDES_FIXED_STANDARD) # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address., noAutomateDnsZone: bool # This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field., portRange: str # This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\\\d+(?:-\\\\d+)?, ports: [str] # This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\\\d+(?:-\\\\d+)?, pscConnectionId: str(uint64) # [Output Only] The PSC connection id of the PSC Forwarding Rule., pscConnectionStatus: str(ACCEPTED/CLOSED/NEEDS_ATTENTION/PENDING/REJECTED/STATUS_UNSPECIFIED), region: str # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., serviceDirectoryRegistrations: [map{namespace: str, service: str, serviceDirectoryRegion: str}] # Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource., serviceLabel: str # An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing., serviceName: str # [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing., sourceIpRanges: [str] # If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24)., subnetwork: str # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6., target: str # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the \"Target\" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}\n@desc Deletes the specified ForwardingRule resource.\n@required {region: str # Name of the region scoping this request., forwardingRule: str # Name of the ForwardingRule resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}\n@desc Returns the specified ForwardingRule resource.\n@required {region: str # Name of the region scoping this request., forwardingRule: str # Name of the ForwardingRule resource to return.}\n@returns(200) {IPAddress: str, IPProtocol: str, allPorts: bool, allowGlobalAccess: bool, allowPscGlobalAccess: bool, backendService: str, baseForwardingRule: str, creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), ipVersion: str, isMirroringCollector: bool, kind: str, labelFingerprint: str(byte), labels: map, loadBalancingScheme: str, metadataFilters: [map], name: str, network: str, networkTier: str, noAutomateDnsZone: bool, portRange: str, ports: [str], pscConnectionId: str(uint64), pscConnectionStatus: str, region: str, selfLink: str, serviceDirectoryRegistrations: [map], serviceLabel: str, serviceName: str, sourceIpRanges: [str], subnetwork: str, target: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}\n@desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.\n@required {region: str # Name of the region scoping this request., forwardingRule: str # Name of the ForwardingRule resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., IPAddress: str # IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number., IPProtocol: str(AH/ESP/ICMP/L3_DEFAULT/SCTP/TCP/UDP) # The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends)., allPorts: bool # This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive., allowGlobalAccess: bool # This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer., allowPscGlobalAccess: bool # This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region., backendService: str # Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types., baseForwardingRule: str # [Output Only] The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., ipVersion: str(IPV4/IPV6/UNSPECIFIED_VERSION) # The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6., isMirroringCollector: bool # Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL., kind: str=compute#forwardingRule # [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule., labels: map # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty., loadBalancingScheme: str(EXTERNAL/EXTERNAL_MANAGED/INTERNAL/INTERNAL_MANAGED/INTERNAL_SELF_MANAGED/INVALID) # Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts., metadataFilters: [map{filterLabels: [map], filterMatchCriteria: str}] # Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED., name: str # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter., network: str # This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided., networkTier: str(FIXED_STANDARD/PREMIUM/STANDARD/STANDARD_OVERRIDES_FIXED_STANDARD) # This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address., noAutomateDnsZone: bool # This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field., portRange: str # This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\\\d+(?:-\\\\d+)?, ports: [str] # This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\\\d+(?:-\\\\d+)?, pscConnectionId: str(uint64) # [Output Only] The PSC connection id of the PSC Forwarding Rule., pscConnectionStatus: str(ACCEPTED/CLOSED/NEEDS_ATTENTION/PENDING/REJECTED/STATUS_UNSPECIFIED), region: str # [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., serviceDirectoryRegistrations: [map{namespace: str, service: str, serviceDirectoryRegion: str}] # Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource., serviceLabel: str # An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing., serviceName: str # [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing., sourceIpRanges: [str] # If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24)., subnetwork: str # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6., target: str # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the \"Target\" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget\n@desc Changes target URL for forwarding rule. The new target should be of the same type as the old target.\n@required {region: str # Name of the region scoping this request., forwardingRule: str # Name of the ForwardingRule resource in which target is to be set.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., target: str}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels\n@desc Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.\n@required {region: str # The region for this request., resource: str # Name or id of the resource for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint., labels: map # The labels to set for this resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/healthCheckServices\n@desc Lists all the HealthCheckService resources that have been configured for the specified project in the given region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/healthCheckServices\n@desc Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService., healthChecks: [str] # A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups., healthStatusAggregationPolicy: str(AND/NO_AGGREGATION) # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#healthCheckService # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services., name: str # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., networkEndpointGroups: [str] # A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT., notificationEndpoints: [str] # A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global., region: str # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}\n@desc Deletes the specified regional HealthCheckService.\n@required {region: str # Name of the region scoping this request., healthCheckService: str # Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}\n@desc Returns the specified regional HealthCheckService resource.\n@required {region: str # Name of the region scoping this request., healthCheckService: str # Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035.}\n@returns(200) {creationTimestamp: str, description: str, fingerprint: str(byte), healthChecks: [str], healthStatusAggregationPolicy: str, id: str(uint64), kind: str, name: str, networkEndpointGroups: [str], notificationEndpoints: [str], region: str, selfLink: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}\n@desc Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {region: str # Name of the region scoping this request., healthCheckService: str # Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService., healthChecks: [str] # A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups., healthStatusAggregationPolicy: str(AND/NO_AGGREGATION) # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#healthCheckService # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services., name: str # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., networkEndpointGroups: [str] # A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT., notificationEndpoints: [str] # A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global., region: str # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/healthChecks\n@desc Retrieves the list of HealthCheck resources available to the specified project.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/healthChecks\n@desc Creates a HealthCheck resource in the specified project using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., checkIntervalSec: int(int32) # How often (in seconds) to send a health check. The default value is 5 seconds., creationTimestamp: str # [Output Only] Creation timestamp in 3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., grpcHealthCheck: map{grpcServiceName: str, port: int(int32), portName: str, portSpecification: str}, healthyThreshold: int(int32) # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2., http2HealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpsHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#healthCheck # Type of the resource., logConfig: map{enable: bool} # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver., name: str # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash., region: str # [Output Only] Region where the health check resides. Not applicable to global health checks., selfLink: str # [Output Only] Server-defined URL for the resource., sslHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, tcpHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, timeoutSec: int(int32) # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec., type: str(GRPC/HTTP/HTTP2/HTTPS/INVALID/SSL/TCP) # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field., unhealthyThreshold: int(int32) # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/healthChecks/{healthCheck}\n@desc Deletes the specified HealthCheck resource.\n@required {region: str # Name of the region scoping this request., healthCheck: str # Name of the HealthCheck resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/healthChecks/{healthCheck}\n@desc Returns the specified HealthCheck resource.\n@required {region: str # Name of the region scoping this request., healthCheck: str # Name of the HealthCheck resource to return.}\n@returns(200) {checkIntervalSec: int(int32), creationTimestamp: str, description: str, grpcHealthCheck: map{grpcServiceName: str, port: int(int32), portName: str, portSpecification: str}, healthyThreshold: int(int32), http2HealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpsHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, id: str(uint64), kind: str, logConfig: map{enable: bool}, name: str, region: str, selfLink: str, sslHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, tcpHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, timeoutSec: int(int32), type: str, unhealthyThreshold: int(int32)} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/healthChecks/{healthCheck}\n@desc Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {region: str # Name of the region scoping this request., healthCheck: str # Name of the HealthCheck resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., checkIntervalSec: int(int32) # How often (in seconds) to send a health check. The default value is 5 seconds., creationTimestamp: str # [Output Only] Creation timestamp in 3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., grpcHealthCheck: map{grpcServiceName: str, port: int(int32), portName: str, portSpecification: str}, healthyThreshold: int(int32) # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2., http2HealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpsHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#healthCheck # Type of the resource., logConfig: map{enable: bool} # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver., name: str # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash., region: str # [Output Only] Region where the health check resides. Not applicable to global health checks., selfLink: str # [Output Only] Server-defined URL for the resource., sslHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, tcpHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, timeoutSec: int(int32) # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec., type: str(GRPC/HTTP/HTTP2/HTTPS/INVALID/SSL/TCP) # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field., unhealthyThreshold: int(int32) # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/regions/{region}/healthChecks/{healthCheck}\n@desc Updates a HealthCheck resource in the specified project using the data included in the request.\n@required {region: str # Name of the region scoping this request., healthCheck: str # Name of the HealthCheck resource to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., checkIntervalSec: int(int32) # How often (in seconds) to send a health check. The default value is 5 seconds., creationTimestamp: str # [Output Only] Creation timestamp in 3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., grpcHealthCheck: map{grpcServiceName: str, port: int(int32), portName: str, portSpecification: str}, healthyThreshold: int(int32) # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2., http2HealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, httpsHealthCheck: map{host: str, port: int(int32), portName: str, portSpecification: str, proxyHeader: str, requestPath: str, response: str}, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#healthCheck # Type of the resource., logConfig: map{enable: bool} # Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver., name: str # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash., region: str # [Output Only] Region where the health check resides. Not applicable to global health checks., selfLink: str # [Output Only] Server-defined URL for the resource., sslHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, tcpHealthCheck: map{port: int(int32), portName: str, portSpecification: str, proxyHeader: str, request: str, response: str}, timeoutSec: int(int32) # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec., type: str(GRPC/HTTP/HTTP2/HTTPS/INVALID/SSL/TCP) # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field., unhealthyThreshold: int(int32) # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/instanceGroupManagers\n@desc Retrieves the list of managed instance groups that are contained within the specified region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers\n@desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoHealingPolicies: [map{healthCheck: str, initialDelaySec: int(int32)}] # The autohealing policy for this managed instance group. You can specify only one value., baseInstanceName: str # 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., creationTimestamp: str # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format., currentActions: map{abandoning: int(int32), creating: int(int32), creatingWithoutRetries: int(int32), deleting: int(int32), none: int(int32), recreating: int(int32), refreshing: int(int32), restarting: int(int32), resuming: int(int32), starting: int(int32), stopping: int(int32), suspending: int(int32), verifying: int(int32)}, description: str # An optional description of this resource., distributionPolicy: map{targetShape: str, zones: [map]}, fingerprint: str(byte) # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager., id: str(uint64) # [Output Only] A unique identifier for this resource type. The server generates this identifier., instanceGroup: str # [Output Only] The URL of the Instance Group resource., instanceTemplate: str # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE., kind: str=compute#instanceGroupManager # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups., listManagedInstancesResults: str(PAGELESS/PAGINATED) # Pagination behavior of the listManagedInstances API method for this managed instance group., name: str # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035., namedPorts: [map{name: str, port: int(int32)}] # Named ports configured for the Instance Groups complementary to this Instance Group Manager., region: str # [Output Only] The URL of the region where the managed instance group resides (for regional resources)., selfLink: str # [Output Only] The URL for this managed instance group. The server defines this URL., statefulPolicy: map{preservedState: map}, status: map{autoscaler: str, isStable: bool, stateful: map, versionTarget: map}, targetPools: [str] # 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., targetSize: int(int32) # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number., updatePolicy: map{instanceRedistributionType: str, maxSurge: map, maxUnavailable: map, minimalAction: str, mostDisruptiveAllowedAction: str, replacementMethod: str, type: str}, versions: [map{instanceTemplate: str, name: str, targetSize: map}] # Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates., zone: str # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}\n@desc Deletes the specified managed instance group and all of the instances in that group.\n@required {region: str # Name of the region scoping this request., instanceGroupManager: str # Name of the managed instance group to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}\n@desc Returns all of the details about the specified managed instance group.\n@required {region: str # Name of the region scoping this request., instanceGroupManager: str # Name of the managed instance group to return.}\n@returns(200) {autoHealingPolicies: [map], baseInstanceName: str, creationTimestamp: str, currentActions: map{abandoning: int(int32), creating: int(int32), creatingWithoutRetries: int(int32), deleting: int(int32), none: int(int32), recreating: int(int32), refreshing: int(int32), restarting: int(int32), resuming: int(int32), starting: int(int32), stopping: int(int32), suspending: int(int32), verifying: int(int32)}, description: str, distributionPolicy: map{targetShape: str, zones: [map]}, fingerprint: str(byte), id: str(uint64), instanceGroup: str, instanceTemplate: str, kind: str, listManagedInstancesResults: str, name: str, namedPorts: [map], region: str, selfLink: str, statefulPolicy: map{preservedState: map{disks: map}}, status: map{autoscaler: str, isStable: bool, stateful: map{hasStatefulConfig: bool, perInstanceConfigs: map{allEffective: bool}}, versionTarget: map{isReached: bool}}, targetPools: [str], targetSize: int(int32), updatePolicy: map{instanceRedistributionType: str, maxSurge: map{calculated: int(int32), fixed: int(int32), percent: int(int32)}, maxUnavailable: map{calculated: int(int32), fixed: int(int32), percent: int(int32)}, minimalAction: str, mostDisruptiveAllowedAction: str, replacementMethod: str, type: str}, versions: [map], zone: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}\n@desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.\n@required {region: str # Name of the region scoping this request., instanceGroupManager: str # The name of the instance group manager.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoHealingPolicies: [map{healthCheck: str, initialDelaySec: int(int32)}] # The autohealing policy for this managed instance group. You can specify only one value., baseInstanceName: str # 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., creationTimestamp: str # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format., currentActions: map{abandoning: int(int32), creating: int(int32), creatingWithoutRetries: int(int32), deleting: int(int32), none: int(int32), recreating: int(int32), refreshing: int(int32), restarting: int(int32), resuming: int(int32), starting: int(int32), stopping: int(int32), suspending: int(int32), verifying: int(int32)}, description: str # An optional description of this resource., distributionPolicy: map{targetShape: str, zones: [map]}, fingerprint: str(byte) # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager., id: str(uint64) # [Output Only] A unique identifier for this resource type. The server generates this identifier., instanceGroup: str # [Output Only] The URL of the Instance Group resource., instanceTemplate: str # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE., kind: str=compute#instanceGroupManager # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups., listManagedInstancesResults: str(PAGELESS/PAGINATED) # Pagination behavior of the listManagedInstances API method for this managed instance group., name: str # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035., namedPorts: [map{name: str, port: int(int32)}] # Named ports configured for the Instance Groups complementary to this Instance Group Manager., region: str # [Output Only] The URL of the region where the managed instance group resides (for regional resources)., selfLink: str # [Output Only] The URL for this managed instance group. The server defines this URL., statefulPolicy: map{preservedState: map}, status: map{autoscaler: str, isStable: bool, stateful: map, versionTarget: map}, targetPools: [str] # 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., targetSize: int(int32) # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number., updatePolicy: map{instanceRedistributionType: str, maxSurge: map, maxUnavailable: map, minimalAction: str, mostDisruptiveAllowedAction: str, replacementMethod: str, type: str}, versions: [map{instanceTemplate: str, name: str, targetSize: map}] # Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates., zone: str # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances\n@desc Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.\n@required {region: str # Name of the region scoping this request., instanceGroupManager: str # Name of the managed instance group.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instances: [str] # The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances\n@desc Apply updates to selected instances the managed instance group.\n@required {region: str # Name of the region scoping this request, should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group, should conform to RFC1035.}\n@optional {allInstances: bool # Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request., instances: [str] # The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]., minimalAction: str(NONE/REFRESH/REPLACE/RESTART) # The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update., mostDisruptiveAllowedAction: str(NONE/REFRESH/REPLACE/RESTART) # The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances\n@desc Creates instances with per-instance configurations in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.\n@required {region: str # The name of the region where the managed instance group is located. It should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group. It should conform to RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instances: [map{fingerprint: str(byte), name: str, preservedState: map, status: str}] # [Required] List of specifications of per-instance configs.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances\n@desc Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.\n@required {region: str # Name of the region scoping this request., instanceGroupManager: str # Name of the managed instance group.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instances: [str] # The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]., skipInstancesOnValidationError: bool # Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs\n@desc Deletes selected per-instance configurations for the managed instance group.\n@required {region: str # Name of the region scoping this request, should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group. It should conform to RFC1035.}\n@optional {names: [str] # The list of instance names for which we want to delete per-instance configs on this managed instance group.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors\n@desc Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported.\n@required {region: str # Name of the region scoping this request. This should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {items: [map], nextPageToken: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances\n@desc Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only in the alpha and beta API and only if the group's `listManagedInstancesResults` field is set to `PAGINATED`.\n@required {region: str # Name of the region scoping this request., instanceGroupManager: str # The name of the managed instance group.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {managedInstances: [map], nextPageToken: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs\n@desc Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.\n@required {region: str # Name of the region scoping this request, should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group. It should conform to RFC1035.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {items: [map], nextPageToken: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs\n@desc Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.\n@required {region: str # Name of the region scoping this request, should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group. It should conform to RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., perInstanceConfigs: [map{fingerprint: str(byte), name: str, preservedState: map, status: str}] # The list of per-instance configurations to insert or patch on this managed instance group.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances\n@desc Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.\n@required {region: str # Name of the region scoping this request., instanceGroupManager: str # Name of the managed instance group.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instances: [str] # The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize\n@desc Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n@required {region: str # Name of the region scoping this request., instanceGroupManager: str # Name of the managed instance group., size: int # Number of instances that should exist in this instance group manager.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate\n@desc Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.\n@required {region: str # Name of the region scoping this request., instanceGroupManager: str # The name of the managed instance group.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instanceTemplate: str # URL of the InstanceTemplate resource from which all new instances will be created.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools\n@desc Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.\n@required {region: str # Name of the region scoping this request., instanceGroupManager: str # Name of the managed instance group.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., fingerprint: str(byte) # Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional., targetPools: [str] # The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs\n@desc Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.\n@required {region: str # Name of the region scoping this request, should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group. It should conform to RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., perInstanceConfigs: [map{fingerprint: str(byte), name: str, preservedState: map, status: str}] # The list of per-instance configurations to insert or patch on this managed instance group.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/instanceGroups\n@desc Retrieves the list of instance group resources contained within the specified region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}\n@desc Returns the specified instance group resource.\n@required {region: str # Name of the region scoping this request., instanceGroup: str # Name of the instance group resource to return.}\n@returns(200) {creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, namedPorts: [map], network: str, region: str, selfLink: str, size: int(int32), subnetwork: str, zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances\n@desc Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running. The orderBy query parameter is not supported.\n@required {region: str # Name of the region scoping this request., instanceGroup: str # Name of the regional instance group for which we want to list the instances.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false., instanceState: str(ALL/RUNNING) # Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances., portName: str # Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts\n@desc Sets the named ports for the specified regional instance group.\n@required {region: str # Name of the region scoping this request., instanceGroup: str # The name of the regional instance group where the named ports are updated.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., fingerprint: str(byte) # 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., namedPorts: [map{name: str, port: int(int32)}] # The list of named ports to set for this instance group.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/instances/bulkInsert\n@desc Creates multiple instances in a given region. Count specifies the number of instances to create.\n@required {region: str # The name of the region for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., count: str(int64) # The maximum number of instances to create., instanceProperties: map{advancedMachineFeatures: map, canIpForward: bool, confidentialInstanceConfig: map, description: str, disks: [map], guestAccelerators: [map], keyRevocationActionType: str, labels: map, machineType: str, metadata: map, minCpuPlatform: str, networkInterfaces: [map], networkPerformanceConfig: map, privateIpv6GoogleAccess: str, reservationAffinity: map, resourceManagerTags: map, resourcePolicies: [str], scheduling: map, serviceAccounts: [map], shieldedInstanceConfig: map, tags: map}, locationPolicy: map{locations: map, targetShape: str} # Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region)., minCount: str(int64) # The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created and instances already created will be deleted., namePattern: str # The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern must contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: a name_pattern of inst-#### generates instance names such as inst-0001 and inst-0002. If existing instances in the same project and zone have names that match the name pattern then the generated instance numbers start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### begin with inst-0051. The name pattern placeholder #...# can contain up to 18 characters., perInstanceProperties: map # Per-instance properties to be set on individual instances. Keys of this map specify requested instance names. Can be empty if name_pattern is used., sourceInstanceTemplate: str # Specifies the instance template from which to create instances. You may combine sourceInstanceTemplate with instanceProperties to override specific values from an existing instance template. Bulk API follows the semantics of JSON Merge Patch described by RFC 7396. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate This field is optional.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/interconnectAttachments\n@desc Retrieves the list of interconnect attachments contained within the specified region.\n@required {region: str # Name of the region for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/interconnectAttachments\n@desc Creates an InterconnectAttachment in the specified project using the data included in the request.\n@required {region: str # Name of the region for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., validateOnly: bool # If true, the request will not be committed., adminEnabled: bool # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER., bandwidth: str(BPS_100M/BPS_10G/BPS_1G/BPS_200M/BPS_20G/BPS_2G/BPS_300M/BPS_400M/BPS_500M/BPS_50G/BPS_50M/BPS_5G) # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s, candidateIpv6Subnets: [str] # This field is not available., candidateSubnets: [str] # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space., cloudRouterIpAddress: str # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment., cloudRouterIpv6Address: str # [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment., cloudRouterIpv6InterfaceId: str # This field is not available., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customerRouterIpAddress: str # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment., customerRouterIpv6Address: str # [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment., customerRouterIpv6InterfaceId: str # This field is not available., dataplaneVersion: int(int32) # [Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1., description: str # An optional description of this resource., edgeAvailabilityDomain: str(AVAILABILITY_DOMAIN_1/AVAILABILITY_DOMAIN_2/AVAILABILITY_DOMAIN_ANY) # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY., encryption: str(IPSEC/NONE) # Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option., googleReferenceId: str # [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., interconnect: str # URL of the underlying Interconnect object that this attachment's traffic will traverse through., ipsecInternalAddresses: [str] # A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool., kind: str=compute#interconnectAttachment # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments., mtu: int(int32) # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440., name: str # 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., operationalStatus: str(OS_ACTIVE/OS_UNPROVISIONED) # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete., pairingKey: str # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form \"XXXXX/region/domain\", partnerAsn: str(int64) # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED., partnerMetadata: map{interconnectName: str, partnerName: str, portalUrl: str} # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments., privateInterconnectInfo: map{tag8021q: int(uint32)} # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED., region: str # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., router: str # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined URL for the resource., stackType: str(IPV4_IPV6/IPV4_ONLY) # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations., state: str(ACTIVE/DEFUNCT/PARTNER_REQUEST_RECEIVED/PENDING_CUSTOMER/PENDING_PARTNER/STATE_UNSPECIFIED/UNPROVISIONED) # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted., type: str(DEDICATED/PARTNER/PARTNER_PROVIDER) # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner., vlanTag8021q: int(int32) # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}\n@desc Deletes the specified interconnect attachment.\n@required {region: str # Name of the region for this request., interconnectAttachment: str # Name of the interconnect attachment to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}\n@desc Returns the specified interconnect attachment.\n@required {region: str # Name of the region for this request., interconnectAttachment: str # Name of the interconnect attachment to return.}\n@returns(200) {adminEnabled: bool, bandwidth: str, candidateIpv6Subnets: [str], candidateSubnets: [str], cloudRouterIpAddress: str, cloudRouterIpv6Address: str, cloudRouterIpv6InterfaceId: str, creationTimestamp: str, customerRouterIpAddress: str, customerRouterIpv6Address: str, customerRouterIpv6InterfaceId: str, dataplaneVersion: int(int32), description: str, edgeAvailabilityDomain: str, encryption: str, googleReferenceId: str, id: str(uint64), interconnect: str, ipsecInternalAddresses: [str], kind: str, mtu: int(int32), name: str, operationalStatus: str, pairingKey: str, partnerAsn: str(int64), partnerMetadata: map{interconnectName: str, partnerName: str, portalUrl: str}, privateInterconnectInfo: map{tag8021q: int(uint32)}, region: str, router: str, satisfiesPzs: bool, selfLink: str, stackType: str, state: str, type: str, vlanTag8021q: int(int32)} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}\n@desc Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {region: str # Name of the region scoping this request., interconnectAttachment: str # Name of the interconnect attachment to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., adminEnabled: bool # Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER., bandwidth: str(BPS_100M/BPS_10G/BPS_1G/BPS_200M/BPS_20G/BPS_2G/BPS_300M/BPS_400M/BPS_500M/BPS_50G/BPS_50M/BPS_5G) # Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s, candidateIpv6Subnets: [str] # This field is not available., candidateSubnets: [str] # Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space., cloudRouterIpAddress: str # [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment., cloudRouterIpv6Address: str # [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment., cloudRouterIpv6InterfaceId: str # This field is not available., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customerRouterIpAddress: str # [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment., customerRouterIpv6Address: str # [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment., customerRouterIpv6InterfaceId: str # This field is not available., dataplaneVersion: int(int32) # [Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1., description: str # An optional description of this resource., edgeAvailabilityDomain: str(AVAILABILITY_DOMAIN_1/AVAILABILITY_DOMAIN_2/AVAILABILITY_DOMAIN_ANY) # Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY., encryption: str(IPSEC/NONE) # Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option., googleReferenceId: str # [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., interconnect: str # URL of the underlying Interconnect object that this attachment's traffic will traverse through., ipsecInternalAddresses: [str] # A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool., kind: str=compute#interconnectAttachment # [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments., mtu: int(int32) # Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440., name: str # 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., operationalStatus: str(OS_ACTIVE/OS_UNPROVISIONED) # [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete., pairingKey: str # [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form \"XXXXX/region/domain\", partnerAsn: str(int64) # Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED., partnerMetadata: map{interconnectName: str, partnerName: str, portalUrl: str} # Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments., privateInterconnectInfo: map{tag8021q: int(uint32)} # Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED., region: str # [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., router: str # URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined URL for the resource., stackType: str(IPV4_IPV6/IPV4_ONLY) # The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations., state: str(ACTIVE/DEFUNCT/PARTNER_REQUEST_RECEIVED/PENDING_CUSTOMER/PENDING_PARTNER/STATE_UNSPECIFIED/UNPROVISIONED) # [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted., type: str(DEDICATED/PARTNER/PARTNER_PROVIDER) # The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner., vlanTag8021q: int(int32) # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels\n@desc Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.\n@required {region: str # The region for this request., resource: str # Name or id of the resource for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint., labels: map # The labels to set for this resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/networkAttachments\n@desc Lists the NetworkAttachments for a project in the given scope.\n@required {region: str # Name of the region of this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/networkAttachments\n@desc Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request.\n@required {region: str # Name of the region of this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder, connectionEndpoints: [map{ipAddress: str, projectIdOrNum: str, secondaryIpCidrRanges: [str], status: str, subnetwork: str}] # [Output Only] An array of connections for all the producers connected to this network attachment., connectionPreference: str(ACCEPT_AUTOMATIC/ACCEPT_MANUAL/INVALID), creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # [Output Only] Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch., id: str(uint64) # [Output Only] The unique identifier for the resource type. The server generates this identifier., kind: str=compute#networkAttachment # [Output Only] Type of the resource., name: str # 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., network: str # [Output Only] The URL of the network which the Network Attachment belongs to., producerAcceptLists: [str] # Projects that are allowed to connect to this network attachment. The project can be specified using its id or number., producerRejectLists: [str] # Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number., region: str # [Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., selfLinkWithId: str # [Output Only] Server-defined URL for this resource's resource id., subnetworks: [str] # An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/networkAttachments/{networkAttachment}\n@desc Deletes the specified NetworkAttachment in the given scope\n@required {region: str # Name of the region of this request., networkAttachment: str # Name of the NetworkAttachment resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/networkAttachments/{networkAttachment}\n@desc Returns the specified NetworkAttachment resource in the given scope.\n@required {region: str # Name of the region of this request., networkAttachment: str # Name of the NetworkAttachment resource to return.}\n@returns(200) {connectionEndpoints: [map], connectionPreference: str, creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, network: str, producerAcceptLists: [str], producerRejectLists: [str], region: str, selfLink: str, selfLinkWithId: str, subnetworks: [str]} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/networkEdgeSecurityServices\n@desc Creates a new service in the specified project using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., validateOnly: bool # If true, the request will not be committed., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#networkEdgeSecurityService # [Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices, name: str # 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., region: str # [Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., securityPolicy: str # The resource URL for the network edge security service associated with this network edge security service., selfLink: str # [Output Only] Server-defined URL for the resource., selfLinkWithId: str # [Output Only] Server-defined URL for this resource with the resource id.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}\n@desc Deletes the specified service.\n@required {region: str # Name of the region scoping this request., networkEdgeSecurityService: str # Name of the network edge security service to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}\n@desc Gets a specified NetworkEdgeSecurityService.\n@required {region: str # Name of the region scoping this request., networkEdgeSecurityService: str # Name of the network edge security service to get.}\n@returns(200) {creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, region: str, securityPolicy: str, selfLink: str, selfLinkWithId: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}\n@desc Patches the specified policy with the data included in the request.\n@required {region: str # Name of the region scoping this request., networkEdgeSecurityService: str # Name of the network edge security service to update.}\n@optional {paths: [str], requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., updateMask: str # Indicates fields to be updated as part of this request., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#networkEdgeSecurityService # [Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices, name: str # 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., region: str # [Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., securityPolicy: str # The resource URL for the network edge security service associated with this network edge security service., selfLink: str # [Output Only] Server-defined URL for the resource., selfLinkWithId: str # [Output Only] Server-defined URL for this resource with the resource id.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/networkEndpointGroups\n@desc Retrieves the list of regional network endpoint groups available to the specified project in the given region.\n@required {region: str # The name of the region where the network endpoint group is located. It should comply with RFC1035.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/networkEndpointGroups\n@desc Creates a network endpoint group in the specified project using the parameters that are included in the request.\n@required {region: str # The name of the region where you want to create the network endpoint group. It should comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., annotations: map # Metadata defined as annotations on the network endpoint group., appEngine: map{service: str, urlMask: str, version: str} # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG., cloudFunction: map{function: str, urlMask: str} # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG., cloudRun: map{service: str, tag: str, urlMask: str} # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., defaultPort: int(int32) # The default port used if the port number is not specified in the network endpoint., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#networkEndpointGroup # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group., name: str # 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., network: str # The URL of the network to which all network endpoints in the NEG belong. Uses \"default\" project network if unspecified., networkEndpointType: str(GCE_VM_IP/GCE_VM_IP_PORT/INTERNET_FQDN_PORT/INTERNET_IP_PORT/NON_GCP_PRIVATE_IP_PORT/PRIVATE_SERVICE_CONNECT/SERVERLESS) # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT., pscData: map{consumerPscAddress: str, pscConnectionId: str(uint64), pscConnectionStatus: str} # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT., pscTargetService: str # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: \"asia-northeast3-cloudkms.googleapis.com\", region: str # [Output Only] The URL of the region where the network endpoint group is located., selfLink: str # [Output Only] Server-defined URL for the resource., size: int(int32) # [Output only] Number of network endpoints in the network endpoint group., subnetwork: str # Optional URL of the subnetwork to which all network endpoints in the NEG belong., zone: str # [Output Only] The URL of the zone where the network endpoint group is located.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}\n@desc Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.\n@required {region: str # The name of the region where the network endpoint group is located. It should comply with RFC1035., networkEndpointGroup: str # The name of the network endpoint group to delete. It should comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}\n@desc Returns the specified network endpoint group.\n@required {region: str # The name of the region where the network endpoint group is located. It should comply with RFC1035., networkEndpointGroup: str # The name of the network endpoint group. It should comply with RFC1035.}\n@returns(200) {annotations: map, appEngine: map{service: str, urlMask: str, version: str}, cloudFunction: map{function: str, urlMask: str}, cloudRun: map{service: str, tag: str, urlMask: str}, creationTimestamp: str, defaultPort: int(int32), description: str, id: str(uint64), kind: str, name: str, network: str, networkEndpointType: str, pscData: map{consumerPscAddress: str, pscConnectionId: str(uint64), pscConnectionStatus: str}, pscTargetService: str, region: str, selfLink: str, size: int(int32), subnetwork: str, zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/nodeTemplates\n@desc Retrieves a list of node templates available to the specified project.\n@required {region: str # The name of the region for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/nodeTemplates\n@desc Creates a NodeTemplate resource in the specified project using the data included in the request.\n@required {region: str # The name of the region for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., accelerators: [map{acceleratorCount: int(int32), acceleratorType: str}], cpuOvercommitType: str(CPU_OVERCOMMIT_TYPE_UNSPECIFIED/ENABLED/NONE) # CPU overcommit., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., disks: [map{diskCount: int(int32), diskSizeGb: int(int32), diskType: str}], id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#nodeTemplate # [Output Only] The type of the resource. Always compute#nodeTemplate for node templates., name: str # 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., nodeAffinityLabels: map # Labels to use for node affinity, which will be used in instance scheduling., nodeType: str # The node type to use for nodes group that are created from this template., nodeTypeFlexibility: map{cpus: str, localSsd: str, memory: str}, region: str # [Output Only] The name of the region where the node template resides, such as us-central1., selfLink: str # [Output Only] Server-defined URL for the resource., serverBinding: map{type: str}, status: str(CREATING/DELETING/INVALID/READY) # [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING., statusMessage: str # [Output Only] An optional, human-readable explanation of the status.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}\n@desc Deletes the specified NodeTemplate resource.\n@required {region: str # The name of the region for this request., nodeTemplate: str # Name of the NodeTemplate resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}\n@desc Returns the specified node template.\n@required {region: str # The name of the region for this request., nodeTemplate: str # Name of the node template to return.}\n@returns(200) {accelerators: [map], cpuOvercommitType: str, creationTimestamp: str, description: str, disks: [map], id: str(uint64), kind: str, name: str, nodeAffinityLabels: map, nodeType: str, nodeTypeFlexibility: map{cpus: str, localSsd: str, memory: str}, region: str, selfLink: str, serverBinding: map{type: str}, status: str, statusMessage: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/notificationEndpoints\n@desc Lists the NotificationEndpoints for a project in the given region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/notificationEndpoints\n@desc Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., grpcSettings: map{authority: str, endpoint: str, payloadName: str, resendInterval: map, retryDurationSec: int(uint32)} # Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint., id: str(uint64) # [Output Only] A unique identifier for this resource type. The server generates this identifier., kind: str=compute#notificationEndpoint # [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints., name: str # 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., region: str # [Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}\n@desc Deletes the specified NotificationEndpoint in the given region\n@required {region: str # Name of the region scoping this request., notificationEndpoint: str # Name of the NotificationEndpoint resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}\n@desc Returns the specified NotificationEndpoint resource in the given region.\n@required {region: str # Name of the region scoping this request., notificationEndpoint: str # Name of the NotificationEndpoint resource to return.}\n@returns(200) {creationTimestamp: str, description: str, grpcSettings: map{authority: str, endpoint: str, payloadName: str, resendInterval: map{nanos: int(int32), seconds: str(int64)}, retryDurationSec: int(uint32)}, id: str(uint64), kind: str, name: str, region: str, selfLink: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/operations\n@desc Retrieves a list of Operation resources contained within the specified region.\n@required {region: str # Name of the region for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/operations/{operation}\n@desc Deletes the specified region-specific Operations resource.\n@required {region: str # Name of the region for this request., operation: str # Name of the Operations resource to delete.}\n@returns(200) Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/operations/{operation}\n@desc Retrieves the specified region-specific Operations resource.\n@required {region: str # Name of the region for this request., operation: str # Name of the Operations resource to return.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/operations/{operation}/wait\n@desc Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`.\n@required {region: str # Name of the region for this request., operation: str # Name of the Operations resource to return.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/packetMirrorings\n@desc Retrieves a list of PacketMirroring resources available to the specified project and region.\n@required {region: str # Name of the region for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/packetMirrorings\n@desc Creates a PacketMirroring resource in the specified project and region using the data included in the request.\n@required {region: str # Name of the region for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., collectorIlb: map{canonicalUrl: str, url: str}, creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., enable: str(FALSE/TRUE) # Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE., filter: map{IPProtocols: [str], cidrRanges: [str], direction: str}, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#packetMirroring # [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings., mirroredResources: map{instances: [map], subnetworks: [map], tags: [str]}, name: str # 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., network: map{canonicalUrl: str, url: str}, priority: int(uint32) # The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535., region: str # [Output Only] URI of the region where the packetMirroring resides., selfLink: str # [Output Only] Server-defined URL for the resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}\n@desc Deletes the specified PacketMirroring resource.\n@required {region: str # Name of the region for this request., packetMirroring: str # Name of the PacketMirroring resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}\n@desc Returns the specified PacketMirroring resource.\n@required {region: str # Name of the region for this request., packetMirroring: str # Name of the PacketMirroring resource to return.}\n@returns(200) {collectorIlb: map{canonicalUrl: str, url: str}, creationTimestamp: str, description: str, enable: str, filter: map{IPProtocols: [str], cidrRanges: [str], direction: str}, id: str(uint64), kind: str, mirroredResources: map{instances: [map], subnetworks: [map], tags: [str]}, name: str, network: map{canonicalUrl: str, url: str}, priority: int(uint32), region: str, selfLink: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}\n@desc Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.\n@required {region: str # Name of the region for this request., packetMirroring: str # Name of the PacketMirroring resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., collectorIlb: map{canonicalUrl: str, url: str}, creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., enable: str(FALSE/TRUE) # Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE., filter: map{IPProtocols: [str], cidrRanges: [str], direction: str}, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#packetMirroring # [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings., mirroredResources: map{instances: [map], subnetworks: [map], tags: [str]}, name: str # 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., network: map{canonicalUrl: str, url: str}, priority: int(uint32) # The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535., region: str # [Output Only] URI of the region where the packetMirroring resides., selfLink: str # [Output Only] Server-defined URL for the resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/publicDelegatedPrefixes\n@desc Lists the PublicDelegatedPrefixes for a project in the given region.\n@required {region: str # Name of the region of this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/publicDelegatedPrefixes\n@desc Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.\n@required {region: str # Name of the region of this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix., id: str(uint64) # [Output Only] The unique identifier for the resource type. The server generates this identifier., ipCidrRange: str # The IPv4 address range, in CIDR format, represented by this public delegated prefix., isLiveMigration: bool # If true, the prefix will be live migrated., kind: str=compute#publicDelegatedPrefix # [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes., name: str # 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., parentPrefix: str # The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix., publicDelegatedSubPrefixs: [map{delegateeProject: str, description: str, ipCidrRange: str, isAddress: bool, name: str, region: str, status: str}] # The list of sub public delegated prefixes that exist for this public delegated prefix., region: str # [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., status: str(ANNOUNCED/DELETING/INITIALIZING/READY_TO_ANNOUNCE) # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}\n@desc Deletes the specified PublicDelegatedPrefix in the given region.\n@required {region: str # Name of the region of this request., publicDelegatedPrefix: str # Name of the PublicDelegatedPrefix resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}\n@desc Returns the specified PublicDelegatedPrefix resource in the given region.\n@required {region: str # Name of the region of this request., publicDelegatedPrefix: str # Name of the PublicDelegatedPrefix resource to return.}\n@returns(200) {creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), ipCidrRange: str, isLiveMigration: bool, kind: str, name: str, parentPrefix: str, publicDelegatedSubPrefixs: [map], region: str, selfLink: str, status: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}\n@desc Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.\n@required {region: str # Name of the region for this request., publicDelegatedPrefix: str # Name of the PublicDelegatedPrefix resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix., id: str(uint64) # [Output Only] The unique identifier for the resource type. The server generates this identifier., ipCidrRange: str # The IPv4 address range, in CIDR format, represented by this public delegated prefix., isLiveMigration: bool # If true, the prefix will be live migrated., kind: str=compute#publicDelegatedPrefix # [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes., name: str # 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., parentPrefix: str # The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix., publicDelegatedSubPrefixs: [map{delegateeProject: str, description: str, ipCidrRange: str, isAddress: bool, name: str, region: str, status: str}] # The list of sub public delegated prefixes that exist for this public delegated prefix., region: str # [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., status: str(ANNOUNCED/DELETING/INITIALIZING/READY_TO_ANNOUNCE) # [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/resourcePolicies\n@desc A list all the resource policies that have been configured for the specified project in specified region.\n@required {region: str # Name of the region for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {etag: str, id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/resourcePolicies\n@desc Creates a new resource policy.\n@required {region: str # Name of the region for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str, groupPlacementPolicy: map{availabilityDomainCount: int(int32), collocation: str, vmCount: int(int32)} # A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., instanceSchedulePolicy: map{expirationTime: str, startTime: str, timeZone: str, vmStartSchedule: map, vmStopSchedule: map} # An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance., kind: str=compute#resourcePolicy # [Output Only] Type of the resource. Always compute#resource_policies for resource policies., name: str # 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., region: str, resourceStatus: map{instanceSchedulePolicy: map} # Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this \"status\" field should mimic the structure of ResourcePolicy proto specification., selfLink: str # [Output Only] Server-defined fully-qualified URL for this resource., snapshotSchedulePolicy: map{retentionPolicy: map, schedule: map, snapshotProperties: map} # A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained., status: str(CREATING/DELETING/EXPIRED/INVALID/READY) # [Output Only] The status of resource policy creation.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}\n@desc Deletes the specified resource policy.\n@required {region: str # Name of the region for this request., resourcePolicy: str # Name of the resource policy to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}\n@desc Retrieves all information of the specified resource policy.\n@required {region: str # Name of the region for this request., resourcePolicy: str # Name of the resource policy to retrieve.}\n@returns(200) {creationTimestamp: str, description: str, groupPlacementPolicy: map{availabilityDomainCount: int(int32), collocation: str, vmCount: int(int32)}, id: str(uint64), instanceSchedulePolicy: map{expirationTime: str, startTime: str, timeZone: str, vmStartSchedule: map{schedule: str}, vmStopSchedule: map{schedule: str}}, kind: str, name: str, region: str, resourceStatus: map{instanceSchedulePolicy: map{lastRunStartTime: str, nextRunStartTime: str}}, selfLink: str, snapshotSchedulePolicy: map{retentionPolicy: map{maxRetentionDays: int(int32), onSourceDiskDelete: str}, schedule: map{dailySchedule: map{daysInCycle: int(int32), duration: str, startTime: str}, hourlySchedule: map{duration: str, hoursInCycle: int(int32), startTime: str}, weeklySchedule: map{dayOfWeeks: [map]}}, snapshotProperties: map{chainName: str, guestFlush: bool, labels: map, storageLocations: [str]}}, status: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/routers\n@desc Retrieves a list of Router resources available to the specified project.\n@required {region: str # Name of the region for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/routers\n@desc Creates a Router resource in the specified project and region using the data included in the request.\n@required {region: str # Name of the region for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., bgp: map{advertiseMode: str, advertisedGroups: [str], advertisedIpRanges: [map], asn: int(uint32), keepaliveInterval: int(uint32)}, bgpPeers: [map{advertiseMode: str, advertisedGroups: [str], advertisedIpRanges: [map], advertisedRoutePriority: int(uint32), bfd: map, enable: str, enableIpv6: bool, interfaceName: str, ipAddress: str, ipv6NexthopAddress: str, managementType: str, md5AuthenticationKeyName: str, name: str, peerAsn: int(uint32), peerIpAddress: str, peerIpv6NexthopAddress: str, routerApplianceInstance: str}] # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., encryptedInterconnectRouter: bool # Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments)., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., interfaces: [map{ipRange: str, linkedInterconnectAttachment: str, linkedVpnTunnel: str, managementType: str, name: str, privateIpAddress: str, redundantInterface: str, subnetwork: str}] # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both., kind: str=compute#router # [Output Only] Type of resource. Always compute#router for routers., md5AuthenticationKeys: [map{key: str, name: str}] # Keys used for MD5 authentication., name: str # 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., nats: [map{drainNatIps: [str], enableDynamicPortAllocation: bool, enableEndpointIndependentMapping: bool, endpointTypes: [str], icmpIdleTimeoutSec: int(int32), logConfig: map, maxPortsPerVm: int(int32), minPortsPerVm: int(int32), name: str, natIpAllocateOption: str, natIps: [str], rules: [map], sourceSubnetworkIpRangesToNat: str, subnetworks: [map], tcpEstablishedIdleTimeoutSec: int(int32), tcpTimeWaitTimeoutSec: int(int32), tcpTransitoryIdleTimeoutSec: int(int32), udpIdleTimeoutSec: int(int32)}] # A list of NAT services created in this router., network: str # URI of the network to which this router belongs., region: str # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/routers/{router}\n@desc Deletes the specified Router resource.\n@required {region: str # Name of the region for this request., router: str # Name of the Router resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/routers/{router}\n@desc Returns the specified Router resource.\n@required {region: str # Name of the region for this request., router: str # Name of the Router resource to return.}\n@returns(200) {bgp: map{advertiseMode: str, advertisedGroups: [str], advertisedIpRanges: [map], asn: int(uint32), keepaliveInterval: int(uint32)}, bgpPeers: [map], creationTimestamp: str, description: str, encryptedInterconnectRouter: bool, id: str(uint64), interfaces: [map], kind: str, md5AuthenticationKeys: [map], name: str, nats: [map], network: str, region: str, selfLink: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/routers/{router}\n@desc Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.\n@required {region: str # Name of the region for this request., router: str # Name of the Router resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., bgp: map{advertiseMode: str, advertisedGroups: [str], advertisedIpRanges: [map], asn: int(uint32), keepaliveInterval: int(uint32)}, bgpPeers: [map{advertiseMode: str, advertisedGroups: [str], advertisedIpRanges: [map], advertisedRoutePriority: int(uint32), bfd: map, enable: str, enableIpv6: bool, interfaceName: str, ipAddress: str, ipv6NexthopAddress: str, managementType: str, md5AuthenticationKeyName: str, name: str, peerAsn: int(uint32), peerIpAddress: str, peerIpv6NexthopAddress: str, routerApplianceInstance: str}] # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., encryptedInterconnectRouter: bool # Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments)., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., interfaces: [map{ipRange: str, linkedInterconnectAttachment: str, linkedVpnTunnel: str, managementType: str, name: str, privateIpAddress: str, redundantInterface: str, subnetwork: str}] # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both., kind: str=compute#router # [Output Only] Type of resource. Always compute#router for routers., md5AuthenticationKeys: [map{key: str, name: str}] # Keys used for MD5 authentication., name: str # 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., nats: [map{drainNatIps: [str], enableDynamicPortAllocation: bool, enableEndpointIndependentMapping: bool, endpointTypes: [str], icmpIdleTimeoutSec: int(int32), logConfig: map, maxPortsPerVm: int(int32), minPortsPerVm: int(int32), name: str, natIpAllocateOption: str, natIps: [str], rules: [map], sourceSubnetworkIpRangesToNat: str, subnetworks: [map], tcpEstablishedIdleTimeoutSec: int(int32), tcpTimeWaitTimeoutSec: int(int32), tcpTransitoryIdleTimeoutSec: int(int32), udpIdleTimeoutSec: int(int32)}] # A list of NAT services created in this router., network: str # URI of the network to which this router belongs., region: str # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/regions/{region}/routers/{router}\n@desc Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.\n@required {region: str # Name of the region for this request., router: str # Name of the Router resource to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., bgp: map{advertiseMode: str, advertisedGroups: [str], advertisedIpRanges: [map], asn: int(uint32), keepaliveInterval: int(uint32)}, bgpPeers: [map{advertiseMode: str, advertisedGroups: [str], advertisedIpRanges: [map], advertisedRoutePriority: int(uint32), bfd: map, enable: str, enableIpv6: bool, interfaceName: str, ipAddress: str, ipv6NexthopAddress: str, managementType: str, md5AuthenticationKeyName: str, name: str, peerAsn: int(uint32), peerIpAddress: str, peerIpv6NexthopAddress: str, routerApplianceInstance: str}] # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., encryptedInterconnectRouter: bool # Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments)., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., interfaces: [map{ipRange: str, linkedInterconnectAttachment: str, linkedVpnTunnel: str, managementType: str, name: str, privateIpAddress: str, redundantInterface: str, subnetwork: str}] # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both., kind: str=compute#router # [Output Only] Type of resource. Always compute#router for routers., md5AuthenticationKeys: [map{key: str, name: str}] # Keys used for MD5 authentication., name: str # 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., nats: [map{drainNatIps: [str], enableDynamicPortAllocation: bool, enableEndpointIndependentMapping: bool, endpointTypes: [str], icmpIdleTimeoutSec: int(int32), logConfig: map, maxPortsPerVm: int(int32), minPortsPerVm: int(int32), name: str, natIpAllocateOption: str, natIps: [str], rules: [map], sourceSubnetworkIpRangesToNat: str, subnetworks: [map], tcpEstablishedIdleTimeoutSec: int(int32), tcpTimeWaitTimeoutSec: int(int32), tcpTransitoryIdleTimeoutSec: int(int32), udpIdleTimeoutSec: int(int32)}] # A list of NAT services created in this router., network: str # URI of the network to which this router belongs., region: str # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo\n@desc Retrieves runtime Nat mapping information of VM endpoints.\n@required {region: str # Name of the region for this request., router: str # Name of the Router resource to query for Nat Mapping information of VM endpoints.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), natName: str # Name of the nat service to filter the Nat Mapping information. If it is omitted, all nats for this router will be returned. Name should conform to RFC1035., orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, kind: str, nextPageToken: str, result: [map], selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/routers/{router}/getRouterStatus\n@desc Retrieves runtime information of the specified router.\n@required {region: str # Name of the region for this request., router: str # Name of the Router resource to query.}\n@returns(200) {kind: str, result: map{bestRoutes: [map], bestRoutesForRouter: [map], bgpPeerStatus: [map], natStatus: [map], network: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/routers/{router}/preview\n@desc Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.\n@required {region: str # Name of the region for this request., router: str # Name of the Router resource to query.}\n@optional {bgp: map{advertiseMode: str, advertisedGroups: [str], advertisedIpRanges: [map], asn: int(uint32), keepaliveInterval: int(uint32)}, bgpPeers: [map{advertiseMode: str, advertisedGroups: [str], advertisedIpRanges: [map], advertisedRoutePriority: int(uint32), bfd: map, enable: str, enableIpv6: bool, interfaceName: str, ipAddress: str, ipv6NexthopAddress: str, managementType: str, md5AuthenticationKeyName: str, name: str, peerAsn: int(uint32), peerIpAddress: str, peerIpv6NexthopAddress: str, routerApplianceInstance: str}] # BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., encryptedInterconnectRouter: bool # Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments)., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., interfaces: [map{ipRange: str, linkedInterconnectAttachment: str, linkedVpnTunnel: str, managementType: str, name: str, privateIpAddress: str, redundantInterface: str, subnetwork: str}] # Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both., kind: str=compute#router # [Output Only] Type of resource. Always compute#router for routers., md5AuthenticationKeys: [map{key: str, name: str}] # Keys used for MD5 authentication., name: str # 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., nats: [map{drainNatIps: [str], enableDynamicPortAllocation: bool, enableEndpointIndependentMapping: bool, endpointTypes: [str], icmpIdleTimeoutSec: int(int32), logConfig: map, maxPortsPerVm: int(int32), minPortsPerVm: int(int32), name: str, natIpAllocateOption: str, natIps: [str], rules: [map], sourceSubnetworkIpRangesToNat: str, subnetworks: [map], tcpEstablishedIdleTimeoutSec: int(int32), tcpTimeWaitTimeoutSec: int(int32), tcpTransitoryIdleTimeoutSec: int(int32), udpIdleTimeoutSec: int(int32)}] # A list of NAT services created in this router., network: str # URI of the network to which this router belongs., region: str # [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource.}\n@returns(200) {resource: map{bgp: map{advertiseMode: str, advertisedGroups: [str], advertisedIpRanges: [map], asn: int(uint32), keepaliveInterval: int(uint32)}, bgpPeers: [map], creationTimestamp: str, description: str, encryptedInterconnectRouter: bool, id: str(uint64), interfaces: [map], kind: str, md5AuthenticationKeys: [map], name: str, nats: [map], network: str, region: str, selfLink: str}} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/securityPolicies\n@desc List all the policies that have been configured for the specified project and region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/securityPolicies\n@desc Creates a new policy in the specified project using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., validateOnly: bool # If true, the request will not be committed., adaptiveProtectionConfig: map{layer7DdosDefenseConfig: map} # Configuration options for Cloud Armor Adaptive Protection (CAAP)., advancedOptionsConfig: map{jsonCustomConfig: map, jsonParsing: str, logLevel: str}, creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., ddosProtectionConfig: map{ddosProtection: str}, description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#securityPolicy # [Output only] Type of the resource. Always compute#securityPolicyfor security policies, name: str # 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., recaptchaOptionsConfig: map{redirectSiteKey: str}, region: str # [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies., rules: [map{action: str, description: str, headerAction: map, kind: str, match: map, preconfiguredWafConfig: map, preview: bool, priority: int(int32), rateLimitOptions: map, redirectOptions: map}] # A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match \"*\" for srcIpRanges and for the networkMatch condition every field must be either match \"*\" or not set). If no rules are provided when creating a security policy, a default rule with action \"allow\" will be added., selfLink: str # [Output Only] Server-defined URL for the resource., type: str(CLOUD_ARMOR/CLOUD_ARMOR_EDGE/CLOUD_ARMOR_NETWORK) # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}\n@desc Deletes the specified policy.\n@required {region: str # Name of the region scoping this request., securityPolicy: str # Name of the security policy to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}\n@desc List all of the ordered rules present in a single specified policy.\n@required {region: str # Name of the region scoping this request., securityPolicy: str # Name of the security policy to get.}\n@returns(200) {adaptiveProtectionConfig: map{layer7DdosDefenseConfig: map{enable: bool, ruleVisibility: str}}, advancedOptionsConfig: map{jsonCustomConfig: map{contentTypes: [str]}, jsonParsing: str, logLevel: str}, creationTimestamp: str, ddosProtectionConfig: map{ddosProtection: str}, description: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, recaptchaOptionsConfig: map{redirectSiteKey: str}, region: str, rules: [map], selfLink: str, type: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/securityPolicies/{securityPolicy}\n@desc Patches the specified policy with the data included in the request. To clear fields in the rule, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.\n@required {region: str # Name of the region scoping this request., securityPolicy: str # Name of the security policy to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., adaptiveProtectionConfig: map{layer7DdosDefenseConfig: map} # Configuration options for Cloud Armor Adaptive Protection (CAAP)., advancedOptionsConfig: map{jsonCustomConfig: map, jsonParsing: str, logLevel: str}, creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., ddosProtectionConfig: map{ddosProtection: str}, description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#securityPolicy # [Output only] Type of the resource. Always compute#securityPolicyfor security policies, name: str # 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., recaptchaOptionsConfig: map{redirectSiteKey: str}, region: str # [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies., rules: [map{action: str, description: str, headerAction: map, kind: str, match: map, preconfiguredWafConfig: map, preview: bool, priority: int(int32), rateLimitOptions: map, redirectOptions: map}] # A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match \"*\" for srcIpRanges and for the networkMatch condition every field must be either match \"*\" or not set). If no rules are provided when creating a security policy, a default rule with action \"allow\" will be added., selfLink: str # [Output Only] Server-defined URL for the resource., type: str(CLOUD_ARMOR/CLOUD_ARMOR_EDGE/CLOUD_ARMOR_NETWORK) # The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/serviceAttachments\n@desc Lists the ServiceAttachments for a project in the given scope.\n@required {region: str # Name of the region of this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/serviceAttachments\n@desc Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.\n@required {region: str # Name of the region of this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., connectedEndpoints: [map{endpoint: str, pscConnectionId: str(uint64), status: str}] # [Output Only] An array of connections for all the consumers connected to this service attachment., connectionPreference: str(ACCEPT_AUTOMATIC/ACCEPT_MANUAL/CONNECTION_PREFERENCE_UNSPECIFIED) # The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules., consumerAcceptLists: [map{connectionLimit: int(uint32), networkUrl: str, projectIdOrNum: str}] # Projects that are allowed to connect to this service attachment., consumerRejectLists: [str] # Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., domainNames: [str] # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: \"p.mycompany.com.\". Current max number of domain names supported is 1., enableProxyProtocol: bool # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment., id: str(uint64) # [Output Only] The unique identifier for the resource type. The server generates this identifier., kind: str=compute#serviceAttachment # [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments., name: str # 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., natSubnets: [str] # An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment., producerForwardingRule: str # The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment., pscServiceAttachmentId: map{high: str(uint64), low: str(uint64)}, region: str # [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., targetService: str # The URL of a service serving the endpoint identified by this service attachment.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}\n@desc Deletes the specified ServiceAttachment in the given scope\n@required {region: str # Name of the region of this request., serviceAttachment: str # Name of the ServiceAttachment resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}\n@desc Returns the specified ServiceAttachment resource in the given scope.\n@required {region: str # Name of the region of this request., serviceAttachment: str # Name of the ServiceAttachment resource to return.}\n@returns(200) {connectedEndpoints: [map], connectionPreference: str, consumerAcceptLists: [map], consumerRejectLists: [str], creationTimestamp: str, description: str, domainNames: [str], enableProxyProtocol: bool, fingerprint: str(byte), id: str(uint64), kind: str, name: str, natSubnets: [str], producerForwardingRule: str, pscServiceAttachmentId: map{high: str(uint64), low: str(uint64)}, region: str, selfLink: str, targetService: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}\n@desc Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.\n@required {region: str # The region scoping this request and should conform to RFC1035., serviceAttachment: str # The resource id of the ServiceAttachment to patch. It should conform to RFC1035 resource name or be a string form on an unsigned long number.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., connectedEndpoints: [map{endpoint: str, pscConnectionId: str(uint64), status: str}] # [Output Only] An array of connections for all the consumers connected to this service attachment., connectionPreference: str(ACCEPT_AUTOMATIC/ACCEPT_MANUAL/CONNECTION_PREFERENCE_UNSPECIFIED) # The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules., consumerAcceptLists: [map{connectionLimit: int(uint32), networkUrl: str, projectIdOrNum: str}] # Projects that are allowed to connect to this service attachment., consumerRejectLists: [str] # Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., domainNames: [str] # If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: \"p.mycompany.com.\". Current max number of domain names supported is 1., enableProxyProtocol: bool # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment., id: str(uint64) # [Output Only] The unique identifier for the resource type. The server generates this identifier., kind: str=compute#serviceAttachment # [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments., name: str # 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., natSubnets: [str] # An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment., producerForwardingRule: str # The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment., pscServiceAttachmentId: map{high: str(uint64), low: str(uint64)}, region: str # [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., targetService: str # The URL of a service serving the endpoint identified by this service attachment.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/sslCertificates\n@desc Retrieves the list of SslCertificate resources available to the specified project in the specified region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/sslCertificates\n@desc Creates a SslCertificate resource in the specified project and region using the data included in the request\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., certificate: str # A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., expireTime: str # [Output Only] Expire time of the certificate. RFC3339, id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#sslCertificate # [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates., managed: map{domainStatus: map, domains: [str], status: str} # Configuration and status of a managed SSL certificate., name: str # 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., privateKey: str # A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field., region: str # [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate., selfLink: str # [Output only] Server-defined URL for the resource., selfManaged: map{certificate: str, privateKey: str} # Configuration and status of a self-managed SSL certificate., subjectAlternativeNames: [str] # [Output Only] Domains associated with the certificate via Subject Alternative Name., type: str(MANAGED/SELF_MANAGED/TYPE_UNSPECIFIED) # (Optional) Specifies the type of SSL certificate, either \"SELF_MANAGED\" or \"MANAGED\". If not specified, the certificate is self-managed and the fields certificate and private_key are used.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/sslCertificates/{sslCertificate}\n@desc Deletes the specified SslCertificate resource in the region.\n@required {region: str # Name of the region scoping this request., sslCertificate: str # Name of the SslCertificate resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/sslCertificates/{sslCertificate}\n@desc Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.\n@required {region: str # Name of the region scoping this request., sslCertificate: str # Name of the SslCertificate resource to return.}\n@returns(200) {certificate: str, creationTimestamp: str, description: str, expireTime: str, id: str(uint64), kind: str, managed: map{domainStatus: map, domains: [str], status: str}, name: str, privateKey: str, region: str, selfLink: str, selfManaged: map{certificate: str, privateKey: str}, subjectAlternativeNames: [str], type: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/sslPolicies\n@desc Lists all the SSL policies that have been configured for the specified project and region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/sslPolicies\n@desc Creates a new policy in the specified project and region using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customFeatures: [str] # A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM., description: str # An optional description of this resource. Provide this property when you create the resource., enabledFeatures: [str] # [Output Only] The list of features enabled in the SSL policy., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#sslPolicy # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies., minTlsVersion: str(TLS_1_0/TLS_1_1/TLS_1_2) # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2., name: str # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., profile: str(COMPATIBLE/CUSTOM/MODERN/RESTRICTED) # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field., region: str # [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies., selfLink: str # [Output Only] Server-defined URL for the resource., warnings: [map{code: str, data: [map], message: str}] # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures\n@desc Lists all features that can be specified in the SSL policy when using custom profile.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {features: [str]} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/sslPolicies/{sslPolicy}\n@desc Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.\n@required {region: str # Name of the region scoping this request., sslPolicy: str # Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/sslPolicies/{sslPolicy}\n@desc Lists all of the ordered rules present in a single specified policy.\n@required {region: str # Name of the region scoping this request., sslPolicy: str # Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.}\n@returns(200) {creationTimestamp: str, customFeatures: [str], description: str, enabledFeatures: [str], fingerprint: str(byte), id: str(uint64), kind: str, minTlsVersion: str, name: str, profile: str, region: str, selfLink: str, warnings: [map]} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/sslPolicies/{sslPolicy}\n@desc Patches the specified SSL policy with the data included in the request.\n@required {region: str # Name of the region scoping this request., sslPolicy: str # Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., customFeatures: [str] # A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM., description: str # An optional description of this resource. Provide this property when you create the resource., enabledFeatures: [str] # [Output Only] The list of features enabled in the SSL policy., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#sslPolicy # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies., minTlsVersion: str(TLS_1_0/TLS_1_1/TLS_1_2) # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2., name: str # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash., profile: str(COMPATIBLE/CUSTOM/MODERN/RESTRICTED) # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field., region: str # [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies., selfLink: str # [Output Only] Server-defined URL for the resource., warnings: [map{code: str, data: [map], message: str}] # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/subnetworks\n@desc Retrieves a list of subnetworks available to the specified project.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/subnetworks\n@desc Creates a subnetwork in the specified project using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time., enableFlowLogs: bool # Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER., externalIpv6Prefix: str # The external IPv6 address range that is owned by this subnetwork., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork., gatewayAddress: str # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., internalIpv6Prefix: str # [Output Only] The internal IPv6 address range that is assigned to this subnetwork., ipCidrRange: str # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange., ipv6AccessType: str(EXTERNAL/INTERNAL) # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack., ipv6CidrRange: str # [Output Only] This field is for internal use., kind: str=compute#subnetwork # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources., logConfig: map{aggregationInterval: str, enable: bool, filterExpr: str, flowSampling: num(float), metadata: str, metadataFields: [str]} # The available logging options for this subnetwork., name: str # 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., network: str # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time., privateIpGoogleAccess: bool # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess., privateIpv6GoogleAccess: str(DISABLE_GOOGLE_ACCESS/ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE/ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE) # This field is for internal use. This field can be both set at resource creation time and updated using patch., purpose: str(INTERNAL_HTTPS_LOAD_BALANCER/PRIVATE/PRIVATE_RFC_1918/PRIVATE_SERVICE_CONNECT/REGIONAL_MANAGED_PROXY) # The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. The enableFlowLogs field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER., region: str # URL of the region where the Subnetwork resides. This field can be set only at resource creation time., role: str(ACTIVE/BACKUP) # The role of subnetwork. Currently, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request., secondaryIpRanges: [map{ipCidrRange: str, rangeName: str}] # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request., selfLink: str # [Output Only] Server-defined URL for the resource., stackType: str(IPV4_IPV6/IPV4_ONLY) # The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch., state: str(DRAINING/READY) # [Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/subnetworks/{subnetwork}\n@desc Deletes the specified subnetwork.\n@required {region: str # Name of the region scoping this request., subnetwork: str # Name of the Subnetwork resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/subnetworks/{subnetwork}\n@desc Returns the specified subnetwork.\n@required {region: str # Name of the region scoping this request., subnetwork: str # Name of the Subnetwork resource to return.}\n@returns(200) {creationTimestamp: str, description: str, enableFlowLogs: bool, externalIpv6Prefix: str, fingerprint: str(byte), gatewayAddress: str, id: str(uint64), internalIpv6Prefix: str, ipCidrRange: str, ipv6AccessType: str, ipv6CidrRange: str, kind: str, logConfig: map{aggregationInterval: str, enable: bool, filterExpr: str, flowSampling: num(float), metadata: str, metadataFields: [str]}, name: str, network: str, privateIpGoogleAccess: bool, privateIpv6GoogleAccess: str, purpose: str, region: str, role: str, secondaryIpRanges: [map], selfLink: str, stackType: str, state: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/subnetworks/{subnetwork}\n@desc Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.\n@required {region: str # Name of the region scoping this request., subnetwork: str # Name of the Subnetwork resource to patch.}\n@optional {drainTimeoutSeconds: int # The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time., enableFlowLogs: bool # Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER., externalIpv6Prefix: str # The external IPv6 address range that is owned by this subnetwork., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork., gatewayAddress: str # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., internalIpv6Prefix: str # [Output Only] The internal IPv6 address range that is assigned to this subnetwork., ipCidrRange: str # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange., ipv6AccessType: str(EXTERNAL/INTERNAL) # The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack., ipv6CidrRange: str # [Output Only] This field is for internal use., kind: str=compute#subnetwork # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources., logConfig: map{aggregationInterval: str, enable: bool, filterExpr: str, flowSampling: num(float), metadata: str, metadataFields: [str]} # The available logging options for this subnetwork., name: str # 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., network: str # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time., privateIpGoogleAccess: bool # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess., privateIpv6GoogleAccess: str(DISABLE_GOOGLE_ACCESS/ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE/ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE) # This field is for internal use. This field can be both set at resource creation time and updated using patch., purpose: str(INTERNAL_HTTPS_LOAD_BALANCER/PRIVATE/PRIVATE_RFC_1918/PRIVATE_SERVICE_CONNECT/REGIONAL_MANAGED_PROXY) # The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. The enableFlowLogs field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER., region: str # URL of the region where the Subnetwork resides. This field can be set only at resource creation time., role: str(ACTIVE/BACKUP) # The role of subnetwork. Currently, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request., secondaryIpRanges: [map{ipCidrRange: str, rangeName: str}] # An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request., selfLink: str # [Output Only] Server-defined URL for the resource., stackType: str(IPV4_IPV6/IPV4_ONLY) # The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch., state: str(DRAINING/READY) # [Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange\n@desc Expands the IP CIDR range of the subnetwork to a specified value.\n@required {region: str # Name of the region scoping this request., subnetwork: str # Name of the Subnetwork resource to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., ipCidrRange: str # The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess\n@desc Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.\n@required {region: str # Name of the region scoping this request., subnetwork: str # Name of the Subnetwork resource.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., privateIpGoogleAccess: bool}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/targetHttpProxies\n@desc Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetHttpProxies\n@desc Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#targetHttpProxy # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies., name: str # 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., proxyBind: bool # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false., region: str # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies., selfLink: str # [Output Only] Server-defined URL for the resource., urlMap: str # URL to the UrlMap resource that defines the mapping from URL to the BackendService.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}\n@desc Deletes the specified TargetHttpProxy resource.\n@required {region: str # Name of the region scoping this request., targetHttpProxy: str # Name of the TargetHttpProxy resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}\n@desc Returns the specified TargetHttpProxy resource in the specified region.\n@required {region: str # Name of the region scoping this request., targetHttpProxy: str # Name of the TargetHttpProxy resource to return.}\n@returns(200) {creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, proxyBind: bool, region: str, selfLink: str, urlMap: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap\n@desc Changes the URL map for TargetHttpProxy.\n@required {region: str # Name of the region scoping this request., targetHttpProxy: str # Name of the TargetHttpProxy to set a URL map for.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., urlMap: str}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/targetHttpsProxies\n@desc Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetHttpsProxies\n@desc Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., authorizationPolicy: str # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact., certificateMap: str # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#targetHttpsProxy # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies., name: str # 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., proxyBind: bool # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false., quicOverride: str(DISABLE/ENABLE/NONE) # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied., region: str # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies., selfLink: str # [Output Only] Server-defined URL for the resource., serverTlsPolicy: str # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted., sslCertificates: [str] # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED., sslPolicy: str # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured., urlMap: str # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}\n@desc Deletes the specified TargetHttpsProxy resource.\n@required {region: str # Name of the region scoping this request., targetHttpsProxy: str # Name of the TargetHttpsProxy resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}\n@desc Returns the specified TargetHttpsProxy resource in the specified region.\n@required {region: str # Name of the region scoping this request., targetHttpsProxy: str # Name of the TargetHttpsProxy resource to return.}\n@returns(200) {authorizationPolicy: str, certificateMap: str, creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, proxyBind: bool, quicOverride: str, region: str, selfLink: str, serverTlsPolicy: str, sslCertificates: [str], sslPolicy: str, urlMap: str} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}\n@desc Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.\n@required {region: str # Name of the region for this request., targetHttpsProxy: str # Name of the TargetHttpsProxy resource to patch.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., authorizationPolicy: str # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact., certificateMap: str # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#targetHttpsProxy # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies., name: str # 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., proxyBind: bool # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false., quicOverride: str(DISABLE/ENABLE/NONE) # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied., region: str # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies., selfLink: str # [Output Only] Server-defined URL for the resource., serverTlsPolicy: str # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted., sslCertificates: [str] # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED., sslPolicy: str # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured., urlMap: str # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates\n@desc Replaces SslCertificates for TargetHttpsProxy.\n@required {region: str # Name of the region scoping this request., targetHttpsProxy: str # Name of the TargetHttpsProxy resource to set an SslCertificates resource for.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sslCertificates: [str] # New set of SslCertificate resources to associate with this TargetHttpsProxy resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap\n@desc Changes the URL map for TargetHttpsProxy.\n@required {region: str # Name of the region scoping this request., targetHttpsProxy: str # Name of the TargetHttpsProxy to set a URL map for.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., urlMap: str}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/targetPools\n@desc Retrieves a list of target pools available to the specified project and region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetPools\n@desc Creates a target pool in the specified project and region using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., backupPool: str # The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., failoverRatio: num(float) # This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy., healthChecks: [str] # The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., instances: [str] # 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., kind: str=compute#targetPool # [Output Only] Type of the resource. Always compute#targetPool for target pools., name: str # 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., region: str # [Output Only] URL of the region where the target pool resides., selfLink: str # [Output Only] Server-defined URL for the resource., sessionAffinity: str(CLIENT_IP/CLIENT_IP_NO_DESTINATION/CLIENT_IP_PORT_PROTO/CLIENT_IP_PROTO/GENERATED_COOKIE/HEADER_FIELD/HTTP_COOKIE/NONE) # Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/targetPools/{targetPool}\n@desc Deletes the specified target pool.\n@required {region: str # Name of the region scoping this request., targetPool: str # Name of the TargetPool resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/targetPools/{targetPool}\n@desc Returns the specified target pool.\n@required {region: str # Name of the region scoping this request., targetPool: str # Name of the TargetPool resource to return.}\n@returns(200) {backupPool: str, creationTimestamp: str, description: str, failoverRatio: num(float), healthChecks: [str], id: str(uint64), instances: [str], kind: str, name: str, region: str, selfLink: str, sessionAffinity: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck\n@desc Adds health check URLs to a target pool.\n@required {region: str # Name of the region scoping this request., targetPool: str # Name of the target pool to add a health check to.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., healthChecks: [map{healthCheck: str}] # The HttpHealthCheck to add to the target pool.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance\n@desc Adds an instance to a target pool.\n@required {region: str # Name of the region scoping this request., targetPool: str # Name of the TargetPool resource to add instances to.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instances: [map{instance: str}] # A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone /instances/instance-name - projects/project-id/zones/zone/instances/instance-name - zones/zone/instances/instance-name}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth\n@desc Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.\n@required {region: str # Name of the region scoping this request., targetPool: str # Name of the TargetPool resource to which the queried instance belongs.}\n@optional {instance: str # The URL for a specific instance. @required compute.instancegroups.addInstances/removeInstances}\n@returns(200) {healthStatus: [map], kind: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck\n@desc Removes health check URL from a target pool.\n@required {region: str # Name of the region for this request., targetPool: str # Name of the target pool to remove health checks from.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., healthChecks: [map{healthCheck: str}] # Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project /global/httpHealthChecks/health-check - projects/project/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance\n@desc Removes instance URL from a target pool.\n@required {region: str # Name of the region scoping this request., targetPool: str # Name of the TargetPool resource to remove instances from.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instances: [map{instance: str}] # URLs of the instances to be removed from target pool.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup\n@desc Changes a backup target pool's configurations.\n@required {region: str # Name of the region scoping this request., targetPool: str # Name of the TargetPool resource to set a backup pool for.}\n@optional {failoverRatio: num # New failoverRatio value for the target pool., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., target: str}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/targetTcpProxies\n@desc Retrieves a list of TargetTcpProxy resources available to the specified project in a given region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetTcpProxies\n@desc Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#targetTcpProxy # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies., name: str # 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., proxyBind: bool # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false., proxyHeader: str(NONE/PROXY_V1) # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE., region: str # [Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy., selfLink: str # [Output Only] Server-defined URL for the resource., service: str # URL to the BackendService resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}\n@desc Deletes the specified TargetTcpProxy resource.\n@required {region: str # Name of the region scoping this request., targetTcpProxy: str # Name of the TargetTcpProxy resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}\n@desc Returns the specified TargetTcpProxy resource.\n@required {region: str # Name of the region scoping this request., targetTcpProxy: str # Name of the TargetTcpProxy resource to return.}\n@returns(200) {creationTimestamp: str, description: str, id: str(uint64), kind: str, name: str, proxyBind: bool, proxyHeader: str, region: str, selfLink: str, service: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/targetVpnGateways\n@desc Retrieves a list of target VPN gateways available to the specified project and region.\n@required {region: str # Name of the region for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetVpnGateways\n@desc Creates a target VPN gateway in the specified project and region using the data included in the request.\n@required {region: str # Name of the region for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., forwardingRules: [str] # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#targetVpnGateway # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways., name: str # 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., network: str # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created., region: str # [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., status: str(CREATING/DELETING/FAILED/READY) # [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING., tunnels: [str] # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels\n@desc Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation.\n@required {region: str # The region for this request., resource: str # Name or id of the resource for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint., labels: map # The labels to set for this resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}\n@desc Deletes the specified target VPN gateway.\n@required {region: str # Name of the region for this request., targetVpnGateway: str # Name of the target VPN gateway to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}\n@desc Returns the specified target VPN gateway.\n@required {region: str # Name of the region for this request., targetVpnGateway: str # Name of the target VPN gateway to return.}\n@returns(200) {creationTimestamp: str, description: str, forwardingRules: [str], id: str(uint64), kind: str, name: str, network: str, region: str, selfLink: str, status: str, tunnels: [str]} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/urlMaps\n@desc Retrieves the list of UrlMap resources available to the specified project in the specified region.\n@required {region: str # Name of the region scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/urlMaps\n@desc Creates a UrlMap resource in the specified project using the data included in the request.\n@required {region: str # Name of the region scoping this request.}\n@optional {requestId: str # begin_interface: MixerMutationRequestBuilder Request ID to support idempotency., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., defaultRouteAction: map{corsPolicy: map, faultInjectionPolicy: map, maxStreamDuration: map, requestMirrorPolicy: map, retryPolicy: map, timeout: map, urlRewrite: map, weightedBackendServices: [map]}, defaultService: str # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true., defaultUrlRedirect: map{hostRedirect: str, httpsRedirect: bool, pathRedirect: str, prefixRedirect: str, redirectResponseCode: str, stripQuery: bool} # Specifies settings for an HTTP redirect., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap., headerAction: map{requestHeadersToAdd: [map], requestHeadersToRemove: [str], responseHeadersToAdd: [map], responseHeadersToRemove: [str]} # The request and response header transformations that take effect before the request is passed along to the selected backendService., hostRules: [map{description: str, hosts: [str], pathMatcher: str}] # The list of host rules to use against the URL., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#urlMap # [Output Only] Type of the resource. Always compute#urlMaps for url maps., name: str # 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., pathMatchers: [map{defaultRouteAction: map, defaultService: str, defaultUrlRedirect: map, description: str, headerAction: map, name: str, pathRules: [map], routeRules: [map]}] # The list of named PathMatchers to use against the URL., region: str # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., tests: [map{description: str, expectedOutputUrl: str, expectedRedirectResponseCode: int(int32), headers: [map], host: str, path: str, service: str}] # The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/urlMaps/{urlMap}\n@desc Deletes the specified UrlMap resource.\n@required {region: str # Name of the region scoping this request., urlMap: str # Name of the UrlMap resource to delete.}\n@optional {requestId: str # begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/urlMaps/{urlMap}\n@desc Returns the specified UrlMap resource.\n@required {region: str # Name of the region scoping this request., urlMap: str # Name of the UrlMap resource to return.}\n@returns(200) {creationTimestamp: str, defaultRouteAction: map{corsPolicy: map{allowCredentials: bool, allowHeaders: [str], allowMethods: [str], allowOriginRegexes: [str], allowOrigins: [str], disabled: bool, exposeHeaders: [str], maxAge: int(int32)}, faultInjectionPolicy: map{abort: map{httpStatus: int(uint32), percentage: num(double)}, delay: map{fixedDelay: map, percentage: num(double)}}, maxStreamDuration: map{nanos: int(int32), seconds: str(int64)}, requestMirrorPolicy: map{backendService: str}, retryPolicy: map{numRetries: int(uint32), perTryTimeout: map{nanos: int(int32), seconds: str(int64)}, retryConditions: [str]}, timeout: map{nanos: int(int32), seconds: str(int64)}, urlRewrite: map{hostRewrite: str, pathPrefixRewrite: str}, weightedBackendServices: [map]}, defaultService: str, defaultUrlRedirect: map{hostRedirect: str, httpsRedirect: bool, pathRedirect: str, prefixRedirect: str, redirectResponseCode: str, stripQuery: bool}, description: str, fingerprint: str(byte), headerAction: map{requestHeadersToAdd: [map], requestHeadersToRemove: [str], responseHeadersToAdd: [map], responseHeadersToRemove: [str]}, hostRules: [map], id: str(uint64), kind: str, name: str, pathMatchers: [map], region: str, selfLink: str, tests: [map]} # Successful response\n\n@endpoint PATCH /projects/{project}/regions/{region}/urlMaps/{urlMap}\n@desc Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.\n@required {region: str # Name of the region scoping this request., urlMap: str # Name of the UrlMap resource to patch.}\n@optional {requestId: str # begin_interface: MixerMutationRequestBuilder Request ID to support idempotency., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., defaultRouteAction: map{corsPolicy: map, faultInjectionPolicy: map, maxStreamDuration: map, requestMirrorPolicy: map, retryPolicy: map, timeout: map, urlRewrite: map, weightedBackendServices: [map]}, defaultService: str # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true., defaultUrlRedirect: map{hostRedirect: str, httpsRedirect: bool, pathRedirect: str, prefixRedirect: str, redirectResponseCode: str, stripQuery: bool} # Specifies settings for an HTTP redirect., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap., headerAction: map{requestHeadersToAdd: [map], requestHeadersToRemove: [str], responseHeadersToAdd: [map], responseHeadersToRemove: [str]} # The request and response header transformations that take effect before the request is passed along to the selected backendService., hostRules: [map{description: str, hosts: [str], pathMatcher: str}] # The list of host rules to use against the URL., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#urlMap # [Output Only] Type of the resource. Always compute#urlMaps for url maps., name: str # 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., pathMatchers: [map{defaultRouteAction: map, defaultService: str, defaultUrlRedirect: map, description: str, headerAction: map, name: str, pathRules: [map], routeRules: [map]}] # The list of named PathMatchers to use against the URL., region: str # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., tests: [map{description: str, expectedOutputUrl: str, expectedRedirectResponseCode: int(int32), headers: [map], host: str, path: str, service: str}] # The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/regions/{region}/urlMaps/{urlMap}\n@desc Updates the specified UrlMap resource with the data included in the request.\n@required {region: str # Name of the region scoping this request., urlMap: str # Name of the UrlMap resource to update.}\n@optional {requestId: str # begin_interface: MixerMutationRequestBuilder Request ID to support idempotency., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., defaultRouteAction: map{corsPolicy: map, faultInjectionPolicy: map, maxStreamDuration: map, requestMirrorPolicy: map, retryPolicy: map, timeout: map, urlRewrite: map, weightedBackendServices: [map]}, defaultService: str # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true., defaultUrlRedirect: map{hostRedirect: str, httpsRedirect: bool, pathRedirect: str, prefixRedirect: str, redirectResponseCode: str, stripQuery: bool} # Specifies settings for an HTTP redirect., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap., headerAction: map{requestHeadersToAdd: [map], requestHeadersToRemove: [str], responseHeadersToAdd: [map], responseHeadersToRemove: [str]} # The request and response header transformations that take effect before the request is passed along to the selected backendService., hostRules: [map{description: str, hosts: [str], pathMatcher: str}] # The list of host rules to use against the URL., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#urlMap # [Output Only] Type of the resource. Always compute#urlMaps for url maps., name: str # 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., pathMatchers: [map{defaultRouteAction: map, defaultService: str, defaultUrlRedirect: map, description: str, headerAction: map, name: str, pathRules: [map], routeRules: [map]}] # The list of named PathMatchers to use against the URL., region: str # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., selfLink: str # [Output Only] Server-defined URL for the resource., tests: [map{description: str, expectedOutputUrl: str, expectedRedirectResponseCode: int(int32), headers: [map], host: str, path: str, service: str}] # The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/urlMaps/{urlMap}/validate\n@desc 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.\n@required {region: str # Name of the region scoping this request., urlMap: str # Name of the UrlMap resource to be validated as.}\n@optional {resource: map{creationTimestamp: str, defaultRouteAction: map, defaultService: str, defaultUrlRedirect: map, description: str, fingerprint: str(byte), headerAction: map, hostRules: [map], id: str(uint64), kind: str, name: str, pathMatchers: [map], region: str, selfLink: str, tests: [map]} # Represents a URL Map resource. Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of cloud load balancers and Traffic Director: * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.}\n@returns(200) {result: map{loadErrors: [str], loadSucceeded: bool, testFailures: [map], testPassed: bool}} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/vpnGateways\n@desc Retrieves a list of VPN gateways available to the specified project and region.\n@required {region: str # Name of the region for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/vpnGateways\n@desc Creates a VPN gateway in the specified project and region using the data included in the request.\n@required {region: str # Name of the region for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#vpnGateway # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnGateway., labels: map # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty., name: str # 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., network: str # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created., region: str # [Output Only] URL of the region where the VPN gateway resides., selfLink: str # [Output Only] Server-defined URL for the resource., stackType: str(IPV4_IPV6/IPV4_ONLY) # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used., vpnInterfaces: [map{id: int(uint32), interconnectAttachment: str, ipAddress: str}] # The list of VPN interfaces associated with this VPN gateway.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels\n@desc Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.\n@required {region: str # The region for this request., resource: str # Name or id of the resource for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint., labels: map # The labels to set for this resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {region: str # The name of the region for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/vpnGateways/{vpnGateway}\n@desc Deletes the specified VPN gateway.\n@required {region: str # Name of the region for this request., vpnGateway: str # Name of the VPN gateway to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/vpnGateways/{vpnGateway}\n@desc Returns the specified VPN gateway.\n@required {region: str # Name of the region for this request., vpnGateway: str # Name of the VPN gateway to return.}\n@returns(200) {creationTimestamp: str, description: str, id: str(uint64), kind: str, labelFingerprint: str(byte), labels: map, name: str, network: str, region: str, selfLink: str, stackType: str, vpnInterfaces: [map]} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus\n@desc Returns the status for the specified VPN gateway.\n@required {region: str # Name of the region for this request., vpnGateway: str # Name of the VPN gateway to return.}\n@returns(200) {result: map{vpnConnections: [map]}} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/vpnTunnels\n@desc Retrieves a list of VpnTunnel resources contained in the specified project and region.\n@required {region: str # Name of the region for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/vpnTunnels\n@desc Creates a VpnTunnel resource in the specified project and region using the data included in the request.\n@required {region: str # Name of the region for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., detailedStatus: str # [Output Only] Detailed status message for the VPN tunnel., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., ikeVersion: int(int32) # IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2., kind: str=compute#vpnTunnel # [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels., localTrafficSelector: [str] # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported., name: str # 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., peerExternalGateway: str # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway., peerExternalGatewayInterface: int(int32) # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type., peerGcpGateway: str # URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway., peerIp: str # IP address of the peer VPN gateway. Only IPv4 is supported., region: str # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., remoteTrafficSelector: [str] # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported., router: str # URL of the router resource to be used for dynamic routing., selfLink: str # [Output Only] Server-defined URL for the resource., sharedSecret: str # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway., sharedSecretHash: str # Hash of the shared secret., status: str(ALLOCATING_RESOURCES/AUTHORIZATION_ERROR/DEPROVISIONING/ESTABLISHED/FAILED/FIRST_HANDSHAKE/NEGOTIATION_FAILURE/NETWORK_ERROR/NO_INCOMING_PACKETS/PROVISIONING/REJECTED/STOPPED/WAITING_FOR_FULL_CONFIG) # [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel., targetVpnGateway: str # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created., vpnGateway: str # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created., vpnGatewayInterface: int(int32) # The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels\n@desc Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation.\n@required {region: str # The region for this request., resource: str # Name or id of the resource for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint., labels: map # The labels to set for this resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}\n@desc Deletes the specified VpnTunnel resource.\n@required {region: str # Name of the region for this request., vpnTunnel: str # Name of the VpnTunnel resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}\n@desc Returns the specified VpnTunnel resource.\n@required {region: str # Name of the region for this request., vpnTunnel: str # Name of the VpnTunnel resource to return.}\n@returns(200) {creationTimestamp: str, description: str, detailedStatus: str, id: str(uint64), ikeVersion: int(int32), kind: str, localTrafficSelector: [str], name: str, peerExternalGateway: str, peerExternalGatewayInterface: int(int32), peerGcpGateway: str, peerIp: str, region: str, remoteTrafficSelector: [str], router: str, selfLink: str, sharedSecret: str, sharedSecretHash: str, status: str, targetVpnGateway: str, vpnGateway: str, vpnGatewayInterface: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/setCommonInstanceMetadata\n@desc Sets metadata common to all instances within the specified project using the data included in the request.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., fingerprint: str(byte) # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource., items: [map{key: str, value: str}] # Array of key/value pairs. The total size of all keys and values must be less than 512 KB., kind: str=compute#metadata # [Output Only] Type of the resource. Always compute#metadata for metadata.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/setDefaultNetworkTier\n@desc Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., networkTier: str(FIXED_STANDARD/PREMIUM/STANDARD/STANDARD_OVERRIDES_FIXED_STANDARD) # Default network tier to be set.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/setUsageExportBucket\n@desc 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.\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., bucketName: str # 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: str # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage_gce. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap\n@desc Changes the URL map for TargetHttpProxy.\n@required {targetHttpProxy: str # Name of the TargetHttpProxy to set a URL map for.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., urlMap: str}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates\n@desc Replaces SslCertificates for TargetHttpsProxy.\n@required {targetHttpsProxy: str # Name of the TargetHttpsProxy resource to set an SslCertificates resource for.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sslCertificates: [str] # New set of SslCertificate resources to associate with this TargetHttpsProxy resource. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap\n@desc Changes the URL map for TargetHttpsProxy.\n@required {targetHttpsProxy: str # Name of the TargetHttpsProxy resource whose URL map is to be set.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., urlMap: str}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones\n@desc Retrieves the list of Zone resources available to the specified project.\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}\n@desc Returns the specified Zone resource.\n@required {zone: str # Name of the zone resource to return.}\n@returns(200) {availableCpuPlatforms: [str], creationTimestamp: str, deprecated: map{deleted: str, deprecated: str, obsolete: str, replacement: str, state: str}, description: str, id: str(uint64), kind: str, name: str, region: str, selfLink: str, status: str, supportsPzs: bool} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/acceleratorTypes\n@desc Retrieves a list of accelerator types that are available to the specified project.\n@required {zone: str # The name of the zone for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}\n@desc Returns the specified accelerator type.\n@required {zone: str # The name of the zone for this request., acceleratorType: str # Name of the accelerator type to return.}\n@returns(200) {creationTimestamp: str, deprecated: map{deleted: str, deprecated: str, obsolete: str, replacement: str, state: str}, description: str, id: str(uint64), kind: str, maximumCardsPerInstance: int(int32), name: str, selfLink: str, zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/autoscalers\n@desc Retrieves a list of autoscalers contained within the specified zone.\n@required {zone: str # Name of the zone for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint PATCH /projects/{project}/zones/{zone}/autoscalers\n@desc Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {zone: str # Name of the zone for this request.}\n@optional {autoscaler: str # Name of the autoscaler to patch., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoscalingPolicy: map{coolDownPeriodSec: int(int32), cpuUtilization: map, customMetricUtilizations: [map], loadBalancingUtilization: map, maxNumReplicas: int(int32), minNumReplicas: int(int32), mode: str, scaleInControl: map, scalingSchedules: map} # Cloud Autoscaler policy., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#autoscaler # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers., name: str # 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., recommendedSize: int(int32) # [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction., region: str # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope)., scalingScheduleStatus: map # [Output Only] Status information of existing scaling schedules., selfLink: str # [Output Only] Server-defined URL for the resource., status: str(ACTIVE/DELETING/ERROR/PENDING) # [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future., statusDetails: [map{message: str, type: str}] # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter., target: str # URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler., zone: str # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/autoscalers\n@desc Creates an autoscaler in the specified project using the data included in the request.\n@required {zone: str # Name of the zone for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoscalingPolicy: map{coolDownPeriodSec: int(int32), cpuUtilization: map, customMetricUtilizations: [map], loadBalancingUtilization: map, maxNumReplicas: int(int32), minNumReplicas: int(int32), mode: str, scaleInControl: map, scalingSchedules: map} # Cloud Autoscaler policy., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#autoscaler # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers., name: str # 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., recommendedSize: int(int32) # [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction., region: str # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope)., scalingScheduleStatus: map # [Output Only] Status information of existing scaling schedules., selfLink: str # [Output Only] Server-defined URL for the resource., status: str(ACTIVE/DELETING/ERROR/PENDING) # [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future., statusDetails: [map{message: str, type: str}] # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter., target: str # URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler., zone: str # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/zones/{zone}/autoscalers\n@desc Updates an autoscaler in the specified project using the data included in the request.\n@required {zone: str # Name of the zone for this request.}\n@optional {autoscaler: str # Name of the autoscaler to update., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoscalingPolicy: map{coolDownPeriodSec: int(int32), cpuUtilization: map, customMetricUtilizations: [map], loadBalancingUtilization: map, maxNumReplicas: int(int32), minNumReplicas: int(int32), mode: str, scaleInControl: map, scalingSchedules: map} # Cloud Autoscaler policy., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#autoscaler # [Output Only] Type of the resource. Always compute#autoscaler for autoscalers., name: str # 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., recommendedSize: int(int32) # [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction., region: str # [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope)., scalingScheduleStatus: map # [Output Only] Status information of existing scaling schedules., selfLink: str # [Output Only] Server-defined URL for the resource., status: str(ACTIVE/DELETING/ERROR/PENDING) # [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future., statusDetails: [map{message: str, type: str}] # [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter., target: str # URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler., zone: str # [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/zones/{zone}/autoscalers/{autoscaler}\n@desc Deletes the specified autoscaler.\n@required {zone: str # Name of the zone for this request., autoscaler: str # Name of the autoscaler to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/autoscalers/{autoscaler}\n@desc Returns the specified autoscaler resource.\n@required {zone: str # Name of the zone for this request., autoscaler: str # Name of the autoscaler to return.}\n@returns(200) {autoscalingPolicy: map{coolDownPeriodSec: int(int32), cpuUtilization: map{predictiveMethod: str, utilizationTarget: num(double)}, customMetricUtilizations: [map], loadBalancingUtilization: map{utilizationTarget: num(double)}, maxNumReplicas: int(int32), minNumReplicas: int(int32), mode: str, scaleInControl: map{maxScaledInReplicas: map{calculated: int(int32), fixed: int(int32), percent: int(int32)}, timeWindowSec: int(int32)}, scalingSchedules: map}, creationTimestamp: str, description: str, id: str(uint64), kind: str, name: str, recommendedSize: int(int32), region: str, scalingScheduleStatus: map, selfLink: str, status: str, statusDetails: [map], target: str, zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/diskTypes\n@desc Retrieves a list of disk types available to the specified project.\n@required {zone: str # The name of the zone for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/diskTypes/{diskType}\n@desc Returns the specified disk type.\n@required {zone: str # The name of the zone for this request., diskType: str # Name of the disk type to return.}\n@returns(200) {creationTimestamp: str, defaultDiskSizeGb: str(int64), deprecated: map{deleted: str, deprecated: str, obsolete: str, replacement: str, state: str}, description: str, id: str(uint64), kind: str, name: str, region: str, selfLink: str, validDiskSize: str, zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/disks\n@desc Retrieves a list of persistent disks contained within the specified zone.\n@required {zone: str # The name of the zone for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/disks\n@desc Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.\n@required {zone: str # The name of the zone for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sourceImage: str # Source image to restore onto a disk. This field is optional., architecture: str(ARCHITECTURE_UNSPECIFIED/ARM64/X86_64) # The architecture of the disk. Valid values are ARM64 or X86_64., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., diskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, guestOsFeatures: [map{type: str}] # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#disk # [Output Only] Type of the resource. Always compute#disk for disks., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk., labels: map # Labels to apply to this disk. These can be later modified by the setLabels method., lastAttachTimestamp: str # [Output Only] Last attach timestamp in RFC3339 text format., lastDetachTimestamp: str # [Output Only] Last detach timestamp in RFC3339 text format., licenseCodes: [str(int64)] # Integer license codes indicating which licenses are attached to this disk., licenses: [str] # A list of publicly visible licenses. Reserved for Google's use., locationHint: str # An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API., name: str # 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., options: str # Internal use only., params: map{resourceManagerTags: map} # Additional disk params., physicalBlockSizeBytes: str(int64) # Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project., provisionedIops: str(int64) # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation., region: str # [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., replicaZones: [str] # URLs of the zones where the disk should be replicated to. Only applicable for regional resources., resourcePolicies: [str] # Resource policies applied to this disk for automatic snapshot creations., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined fully-qualified URL for this resource., sizeGb: str(int64) # Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive., sourceDisk: str # The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk, sourceDiskId: str # [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used., sourceImage: str # The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family, sourceImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceImageId: str # [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: str # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot, sourceSnapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceSnapshotId: str # [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., sourceStorageObject: str # The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead., status: str(CREATING/DELETING/FAILED/READY/RESTORING) # [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting., type: str # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types., users: [str] # [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance, zone: str # [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/zones/{zone}/disks/{disk}\n@desc 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.\n@required {zone: str # The name of the zone for this request., disk: str # Name of the persistent disk to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/disks/{disk}\n@desc Returns the specified persistent disk.\n@required {zone: str # The name of the zone for this request., disk: str # Name of the persistent disk to return.}\n@returns(200) {architecture: str, creationTimestamp: str, description: str, diskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, guestOsFeatures: [map], id: str(uint64), kind: str, labelFingerprint: str(byte), labels: map, lastAttachTimestamp: str, lastDetachTimestamp: str, licenseCodes: [str(int64)], licenses: [str], locationHint: str, name: str, options: str, params: map{resourceManagerTags: map}, physicalBlockSizeBytes: str(int64), provisionedIops: str(int64), region: str, replicaZones: [str], resourcePolicies: [str], satisfiesPzs: bool, selfLink: str, sizeGb: str(int64), sourceDisk: str, sourceDiskId: str, sourceImage: str, sourceImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceImageId: str, sourceSnapshot: str, sourceSnapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceSnapshotId: str, sourceStorageObject: str, status: str, type: str, users: [str], zone: str} # Successful response\n\n@endpoint PATCH /projects/{project}/zones/{zone}/disks/{disk}\n@desc Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: user_license.\n@required {zone: str # The name of the zone for this request., disk: str # The disk name for this request.}\n@optional {paths: [str], requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., updateMask: str # update_mask indicates fields to be updated as part of this request., architecture: str(ARCHITECTURE_UNSPECIFIED/ARM64/X86_64) # The architecture of the disk. Valid values are ARM64 or X86_64., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., diskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, guestOsFeatures: [map{type: str}] # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#disk # [Output Only] Type of the resource. Always compute#disk for disks., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk., labels: map # Labels to apply to this disk. These can be later modified by the setLabels method., lastAttachTimestamp: str # [Output Only] Last attach timestamp in RFC3339 text format., lastDetachTimestamp: str # [Output Only] Last detach timestamp in RFC3339 text format., licenseCodes: [str(int64)] # Integer license codes indicating which licenses are attached to this disk., licenses: [str] # A list of publicly visible licenses. Reserved for Google's use., locationHint: str # An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API., name: str # 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., options: str # Internal use only., params: map{resourceManagerTags: map} # Additional disk params., physicalBlockSizeBytes: str(int64) # Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project., provisionedIops: str(int64) # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation., region: str # [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body., replicaZones: [str] # URLs of the zones where the disk should be replicated to. Only applicable for regional resources., resourcePolicies: [str] # Resource policies applied to this disk for automatic snapshot creations., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined fully-qualified URL for this resource., sizeGb: str(int64) # Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive., sourceDisk: str # The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk, sourceDiskId: str # [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used., sourceImage: str # The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family, sourceImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceImageId: str # [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: str # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot, sourceSnapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceSnapshotId: str # [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., sourceStorageObject: str # The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead., status: str(CREATING/DELETING/FAILED/READY/RESTORING) # [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting., type: str # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types., users: [str] # [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance, zone: str # [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies\n@desc Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.\n@required {zone: str # The name of the zone for this request., disk: str # The disk name for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., resourcePolicies: [str] # Full or relative path to the resource policy to be added to this disk. You can only specify one resource policy.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/disks/{disk}/createSnapshot\n@desc Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.\n@required {zone: str # The name of the zone for this request., disk: str # Name of the persistent disk to snapshot.}\n@optional {guestFlush: bool # [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., architecture: str(ARCHITECTURE_UNSPECIFIED/ARM64/X86_64) # [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64., autoCreated: bool # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk., chainName: str # Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value., creationSizeBytes: str(int64) # [Output Only] Size in bytes of the snapshot at creation time., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., diskSizeGb: str(int64) # [Output Only] Size of the source disk, specified in GB., downloadBytes: str(int64) # [Output Only] Number of bytes downloaded to restore a snapshot to a disk., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#snapshot # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources., labelFingerprint: str(byte) # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot., labels: map # Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty., licenseCodes: [str(int64)] # [Output Only] Integer license codes indicating which licenses are attached to this snapshot., licenses: [str] # [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)., locationHint: str # An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API., name: str # 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., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined URL for the resource., snapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, snapshotType: str(ARCHIVE/STANDARD) # Indicates the type of the snapshot., sourceDisk: str # The source disk used to create this snapshot., sourceDiskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceDiskId: str # [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., sourceSnapshotSchedulePolicy: str # [Output Only] URL of the resource policy which created this scheduled snapshot., sourceSnapshotSchedulePolicyId: str # [Output Only] ID of the resource policy which created this scheduled snapshot., status: str(CREATING/DELETING/FAILED/READY/UPLOADING) # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING., storageBytes: str(int64) # [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion., storageBytesStatus: str(UPDATING/UP_TO_DATE) # [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., storageLocations: [str] # Cloud Storage bucket storage location of the snapshot (regional or multi-regional).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies\n@desc Removes resource policies from a disk.\n@required {zone: str # The name of the zone for this request., disk: str # The disk name for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., resourcePolicies: [str] # Resource policies to be removed from this disk.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/disks/{disk}/resize\n@desc Resizes the specified persistent disk. You can only increase the size of the disk.\n@required {zone: str # The name of the zone for this request., disk: str # The name of the persistent disk.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sizeGb: str(int64) # The new size of the persistent disk, which is specified in GB.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/disks/{resource}/setLabels\n@desc Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., labelFingerprint: str(byte) # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint., labels: map # The labels to set for this resource.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/imageFamilyViews/{family}\n@desc Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.\n@required {zone: str # The name of the zone for this request., family: str # Name of the image family to search for.}\n@returns(200) {image: map{architecture: str, archiveSizeBytes: str(int64), creationTimestamp: str, deprecated: map{deleted: str, deprecated: str, obsolete: str, replacement: str, state: str}, description: str, diskSizeGb: str(int64), family: str, guestOsFeatures: [map], id: str(uint64), imageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, kind: str, labelFingerprint: str(byte), labels: map, licenseCodes: [str(int64)], licenses: [str], name: str, rawDisk: map{containerType: str, sha1Checksum: str, source: str}, satisfiesPzs: bool, selfLink: str, shieldedInstanceInitialState: map{dbs: [map], dbxs: [map], keks: [map], pk: map{content: str(byte), fileType: str}}, sourceDisk: str, sourceDiskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceDiskId: str, sourceImage: str, sourceImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceImageId: str, sourceSnapshot: str, sourceSnapshotEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, sourceSnapshotId: str, sourceType: str, status: str, storageLocations: [str]}} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instanceGroupManagers\n@desc Retrieves a list of managed instance groups that are contained within the specified project and zone.\n@required {zone: str # The name of the zone where the managed instance group is located.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers\n@desc Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.\n@required {zone: str # The name of the zone where you want to create the managed instance group.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoHealingPolicies: [map{healthCheck: str, initialDelaySec: int(int32)}] # The autohealing policy for this managed instance group. You can specify only one value., baseInstanceName: str # 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., creationTimestamp: str # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format., currentActions: map{abandoning: int(int32), creating: int(int32), creatingWithoutRetries: int(int32), deleting: int(int32), none: int(int32), recreating: int(int32), refreshing: int(int32), restarting: int(int32), resuming: int(int32), starting: int(int32), stopping: int(int32), suspending: int(int32), verifying: int(int32)}, description: str # An optional description of this resource., distributionPolicy: map{targetShape: str, zones: [map]}, fingerprint: str(byte) # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager., id: str(uint64) # [Output Only] A unique identifier for this resource type. The server generates this identifier., instanceGroup: str # [Output Only] The URL of the Instance Group resource., instanceTemplate: str # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE., kind: str=compute#instanceGroupManager # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups., listManagedInstancesResults: str(PAGELESS/PAGINATED) # Pagination behavior of the listManagedInstances API method for this managed instance group., name: str # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035., namedPorts: [map{name: str, port: int(int32)}] # Named ports configured for the Instance Groups complementary to this Instance Group Manager., region: str # [Output Only] The URL of the region where the managed instance group resides (for regional resources)., selfLink: str # [Output Only] The URL for this managed instance group. The server defines this URL., statefulPolicy: map{preservedState: map}, status: map{autoscaler: str, isStable: bool, stateful: map, versionTarget: map}, targetPools: [str] # 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., targetSize: int(int32) # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number., updatePolicy: map{instanceRedistributionType: str, maxSurge: map, maxUnavailable: map, minimalAction: str, mostDisruptiveAllowedAction: str, replacementMethod: str, type: str}, versions: [map{instanceTemplate: str, name: str, targetSize: map}] # Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates., zone: str # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}\n@desc 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.\n@required {zone: str # The name of the zone where the managed instance group is located., instanceGroupManager: str # The name of the managed instance group to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}\n@desc Returns all of the details about the specified managed instance group.\n@required {zone: str # The name of the zone where the managed instance group is located., instanceGroupManager: str # The name of the managed instance group.}\n@returns(200) {autoHealingPolicies: [map], baseInstanceName: str, creationTimestamp: str, currentActions: map{abandoning: int(int32), creating: int(int32), creatingWithoutRetries: int(int32), deleting: int(int32), none: int(int32), recreating: int(int32), refreshing: int(int32), restarting: int(int32), resuming: int(int32), starting: int(int32), stopping: int(int32), suspending: int(int32), verifying: int(int32)}, description: str, distributionPolicy: map{targetShape: str, zones: [map]}, fingerprint: str(byte), id: str(uint64), instanceGroup: str, instanceTemplate: str, kind: str, listManagedInstancesResults: str, name: str, namedPorts: [map], region: str, selfLink: str, statefulPolicy: map{preservedState: map{disks: map}}, status: map{autoscaler: str, isStable: bool, stateful: map{hasStatefulConfig: bool, perInstanceConfigs: map{allEffective: bool}}, versionTarget: map{isReached: bool}}, targetPools: [str], targetSize: int(int32), updatePolicy: map{instanceRedistributionType: str, maxSurge: map{calculated: int(int32), fixed: int(int32), percent: int(int32)}, maxUnavailable: map{calculated: int(int32), fixed: int(int32), percent: int(int32)}, minimalAction: str, mostDisruptiveAllowedAction: str, replacementMethod: str, type: str}, versions: [map], zone: str} # Successful response\n\n@endpoint PATCH /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}\n@desc Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG.\n@required {zone: str # The name of the zone where you want to create the managed instance group., instanceGroupManager: str # The name of the instance group manager.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoHealingPolicies: [map{healthCheck: str, initialDelaySec: int(int32)}] # The autohealing policy for this managed instance group. You can specify only one value., baseInstanceName: str # 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., creationTimestamp: str # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format., currentActions: map{abandoning: int(int32), creating: int(int32), creatingWithoutRetries: int(int32), deleting: int(int32), none: int(int32), recreating: int(int32), refreshing: int(int32), restarting: int(int32), resuming: int(int32), starting: int(int32), stopping: int(int32), suspending: int(int32), verifying: int(int32)}, description: str # An optional description of this resource., distributionPolicy: map{targetShape: str, zones: [map]}, fingerprint: str(byte) # Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager., id: str(uint64) # [Output Only] A unique identifier for this resource type. The server generates this identifier., instanceGroup: str # [Output Only] The URL of the Instance Group resource., instanceTemplate: str # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE., kind: str=compute#instanceGroupManager # [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups., listManagedInstancesResults: str(PAGELESS/PAGINATED) # Pagination behavior of the listManagedInstances API method for this managed instance group., name: str # The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035., namedPorts: [map{name: str, port: int(int32)}] # Named ports configured for the Instance Groups complementary to this Instance Group Manager., region: str # [Output Only] The URL of the region where the managed instance group resides (for regional resources)., selfLink: str # [Output Only] The URL for this managed instance group. The server defines this URL., statefulPolicy: map{preservedState: map}, status: map{autoscaler: str, isStable: bool, stateful: map, versionTarget: map}, targetPools: [str] # 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., targetSize: int(int32) # The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number., updatePolicy: map{instanceRedistributionType: str, maxSurge: map, maxUnavailable: map, minimalAction: str, mostDisruptiveAllowedAction: str, replacementMethod: str, type: str}, versions: [map{instanceTemplate: str, name: str, targetSize: map}] # Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates., zone: str # [Output Only] The URL of a zone where the managed instance group is located (for zonal resources).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances\n@desc Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.\n@required {zone: str # The name of the zone where the managed instance group is located., instanceGroupManager: str # The name of the managed instance group.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instances: [str] # The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances\n@desc Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.\n@required {zone: str # The name of the zone where the managed instance group is located. Should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group, should conform to RFC1035.}\n@optional {allInstances: bool # Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request., instances: [str] # The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]., minimalAction: str(NONE/REFRESH/REPLACE/RESTART) # The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update., mostDisruptiveAllowedAction: str(NONE/REFRESH/REPLACE/RESTART) # The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances\n@desc Creates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.\n@required {zone: str # The name of the zone where the managed instance group is located. It should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group. It should conform to RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instances: [map{fingerprint: str(byte), name: str, preservedState: map, status: str}] # [Required] List of specifications of per-instance configs.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances\n@desc Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.\n@required {zone: str # The name of the zone where the managed instance group is located., instanceGroupManager: str # The name of the managed instance group.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instances: [str] # The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. Queued instances do not have URL and can be deleted only by name. One cannot specify both URLs and names in a single request., skipInstancesOnValidationError: bool # Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to `false` and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs\n@desc Deletes selected per-instance configurations for the managed instance group.\n@required {zone: str # The name of the zone where the managed instance group is located. It should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group. It should conform to RFC1035.}\n@optional {names: [str] # The list of instance names for which we want to delete per-instance configs on this managed instance group.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors\n@desc Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported.\n@required {zone: str # The name of the zone where the managed instance group is located. It should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {items: [map], nextPageToken: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances\n@desc Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action. The orderBy query parameter is not supported. The `pageToken` query parameter is supported only in the alpha and beta API and only if the group's `listManagedInstancesResults` field is set to `PAGINATED`.\n@required {zone: str # The name of the zone where the managed instance group is located., instanceGroupManager: str # The name of the managed instance group.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {managedInstances: [map], nextPageToken: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs\n@desc Lists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported.\n@required {zone: str # The name of the zone where the managed instance group is located. It should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group. It should conform to RFC1035.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {items: [map], nextPageToken: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs\n@desc Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.\n@required {zone: str # The name of the zone where the managed instance group is located. It should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group. It should conform to RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., perInstanceConfigs: [map{fingerprint: str(byte), name: str, preservedState: map, status: str}] # The list of per-instance configurations to insert or patch on this managed instance group.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances\n@desc Flags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current configuration. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of each instance by checking its currentAction field; for more information, see Checking the status of managed instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request.\n@required {zone: str # The name of the zone where the managed instance group is located., instanceGroupManager: str # The name of the managed instance group.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instances: [str] # The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize\n@desc Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. When resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including: + The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance. This list is subject to change. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n@required {zone: str # The name of the zone where the managed instance group is located., instanceGroupManager: str # The name of the managed instance group., size: int # 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.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate\n@desc Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.\n@required {zone: str # The name of the zone where the managed instance group is located., instanceGroupManager: str # The name of the managed instance group.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instanceTemplate: str # The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools\n@desc 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.\n@required {zone: str # The name of the zone where the managed instance group is located., instanceGroupManager: str # The name of the managed instance group.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., fingerprint: str(byte) # 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., targetPools: [str] # 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.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs\n@desc Inserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch.\n@required {zone: str # The name of the zone where the managed instance group is located. It should conform to RFC1035., instanceGroupManager: str # The name of the managed instance group. It should conform to RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., perInstanceConfigs: [map{fingerprint: str(byte), name: str, preservedState: map, status: str}] # The list of per-instance configurations to insert or patch on this managed instance group.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instanceGroups\n@desc Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.\n@required {zone: str # The name of the zone where the instance group is located.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroups\n@desc Creates an instance group in the specified project using the parameters that are included in the request.\n@required {zone: str # The name of the zone where you want to create the instance group.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] The creation timestamp for this instance group in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte) # [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently., id: str(uint64) # [Output Only] A unique identifier for this instance group, generated by the server., kind: str=compute#instanceGroup # [Output Only] The resource type, which is always compute#instanceGroup for instance groups., name: str # The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035., namedPorts: [map{name: str, port: int(int32)}] # Assigns a name to a port number. For example: {name: \"http\", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"app1\", port: 8080}, {name: \"app1\", port: 8081}, {name: \"app2\", port: 8082}] Named ports apply to all instances in this instance group., network: str # [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0)., region: str # [Output Only] The URL of the region where the instance group is located (for regional resources)., selfLink: str # [Output Only] The URL for this instance group. The server generates this URL., size: int(int32) # [Output Only] The total number of instances in the instance group., subnetwork: str # [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0)., zone: str # [Output Only] The URL of the zone where the instance group is located (for zonal resources).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}\n@desc 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.\n@required {zone: str # The name of the zone where the instance group is located., instanceGroup: str # The name of the instance group to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}\n@desc Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.\n@required {zone: str # The name of the zone where the instance group is located., instanceGroup: str # The name of the instance group.}\n@returns(200) {creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), kind: str, name: str, namedPorts: [map], network: str, region: str, selfLink: str, size: int(int32), subnetwork: str, zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances\n@desc 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.\n@required {zone: str # The name of the zone where the instance group is located., instanceGroup: str # The name of the instance group where you are adding instances.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instances: [map{instance: str}] # The list of instances to add to the instance group.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances\n@desc Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use `eq` (equal) or `ne` (not equal) operators.\n@required {zone: str # The name of the zone where the instance group is located., instanceGroup: str # The name of the instance group from which you want to generate a list of included instances.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false., instanceState: str(ALL/RUNNING) # 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.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances\n@desc Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.\n@required {zone: str # The name of the zone where the instance group is located., instanceGroup: str # The name of the instance group where the specified instances will be removed.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., instances: [map{instance: str}] # The list of instances to remove from the instance group.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts\n@desc Sets the named ports for the specified instance group.\n@required {zone: str # The name of the zone where the instance group is located., instanceGroup: str # The name of the instance group where the named ports are updated.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., fingerprint: str(byte) # The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet., namedPorts: [map{name: str, port: int(int32)}] # The list of named ports to set for this instance group.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instances\n@desc Retrieves the list of instances contained within the specified zone.\n@required {zone: str # The name of the zone for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances\n@desc Creates an instance resource in the specified project using the data included in the request.\n@required {zone: str # The name of the zone for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., sourceInstanceTemplate: str # Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate, sourceMachineImage: str # Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global /machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage, advancedMachineFeatures: map{enableNestedVirtualization: bool, enableUefiNetworking: bool, threadsPerCore: int(int32), visibleCoreCount: int(int32)} # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled)., canIpForward: bool # 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 ., confidentialInstanceConfig: map{enableConfidentialCompute: bool} # A set of Confidential Instance options., cpuPlatform: str # [Output Only] The CPU platform used by this instance., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., deletionProtection: bool # Whether the resource should be protected against deletion., description: str # An optional description of this resource. Provide this property when you create the resource., disks: [map{architecture: str, autoDelete: bool, boot: bool, deviceName: str, diskEncryptionKey: map, diskSizeGb: str(int64), forceAttach: bool, guestOsFeatures: [map], index: int(int32), initializeParams: map, interface: str, kind: str, licenses: [str], mode: str, shieldedInstanceInitialState: map, source: str, type: str}] # Array of disks associated with this instance. Persistent disks must be created before you can assign them., displayDevice: map{enableDisplay: bool} # A set of Display Device options, fingerprint: str(byte) # Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance., guestAccelerators: [map{acceleratorCount: int(int32), acceleratorType: str}] # A list of the type and count of accelerator cards attached to the instance., hostname: str # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., keyRevocationActionType: str(KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED/NONE/STOP) # KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified., kind: str=compute#instance # [Output Only] Type of the resource. Always compute#instance for instances., labelFingerprint: str(byte) # A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance., labels: map # Labels to apply to this instance. These can be later modified by the setLabels method., lastStartTimestamp: str # [Output Only] Last start timestamp in RFC3339 text format., lastStopTimestamp: str # [Output Only] Last stop timestamp in RFC3339 text format., lastSuspendedTimestamp: str # [Output Only] Last suspended timestamp in RFC3339 text format., machineType: str # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types., metadata: map{fingerprint: str(byte), items: [map], kind: str} # A metadata key/value entry., minCpuPlatform: str # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\"., name: str # 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: [map{accessConfigs: [map], aliasIpRanges: [map], fingerprint: str(byte), internalIpv6PrefixLength: int(int32), ipv6AccessConfigs: [map], ipv6AccessType: str, ipv6Address: str, kind: str, name: str, network: str, networkAttachment: str, networkIP: str, nicType: str, queueCount: int(int32), stackType: str, subnetwork: str}] # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance., networkPerformanceConfig: map{totalEgressBandwidthTier: str}, params: map{resourceManagerTags: map} # Additional instance params., privateIpv6GoogleAccess: str(ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE/ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE/INHERIT_FROM_SUBNETWORK) # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default., reservationAffinity: map{consumeReservationType: str, key: str, values: [str]} # Specifies the reservations that this instance can consume from., resourcePolicies: [str] # Resource policies applied to this instance., resourceStatus: map{physicalHost: str} # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls., satisfiesPzs: bool # [Output Only] Reserved for future use., scheduling: map{automaticRestart: bool, instanceTerminationAction: str, locationHint: str, minNodeCpus: int(int32), nodeAffinities: [map], onHostMaintenance: str, preemptible: bool, provisioningModel: str} # Sets the scheduling options for an Instance., selfLink: str # [Output Only] Server-defined URL for this resource., serviceAccounts: [map{email: str, scopes: [str]}] # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information., shieldedInstanceConfig: map{enableIntegrityMonitoring: bool, enableSecureBoot: bool, enableVtpm: bool} # A set of Shielded Instance options., shieldedInstanceIntegrityPolicy: map{updateAutoLearnPolicy: bool} # The policy describes the baseline against which Instance boot integrity is measured., sourceMachineImage: str # Source machine image, sourceMachineImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, startRestricted: bool # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity., status: str(DEPROVISIONING/PROVISIONING/REPAIRING/RUNNING/STAGING/STOPPED/STOPPING/SUSPENDED/SUSPENDING/TERMINATED) # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle., statusMessage: str # [Output Only] An optional, human-readable explanation of the status., tags: map{fingerprint: str(byte), items: [str]} # A set of instance tags., zone: str # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/bulkInsert\n@desc Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs.\n@required {zone: str # The name of the zone for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., count: str(int64) # The maximum number of instances to create., instanceProperties: map{advancedMachineFeatures: map, canIpForward: bool, confidentialInstanceConfig: map, description: str, disks: [map], guestAccelerators: [map], keyRevocationActionType: str, labels: map, machineType: str, metadata: map, minCpuPlatform: str, networkInterfaces: [map], networkPerformanceConfig: map, privateIpv6GoogleAccess: str, reservationAffinity: map, resourceManagerTags: map, resourcePolicies: [str], scheduling: map, serviceAccounts: [map], shieldedInstanceConfig: map, tags: map}, locationPolicy: map{locations: map, targetShape: str} # Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region)., minCount: str(int64) # The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created and instances already created will be deleted., namePattern: str # The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern must contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: a name_pattern of inst-#### generates instance names such as inst-0001 and inst-0002. If existing instances in the same project and zone have names that match the name pattern then the generated instance numbers start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### begin with inst-0051. The name pattern placeholder #...# can contain up to 18 characters., perInstanceProperties: map # Per-instance properties to be set on individual instances. Keys of this map specify requested instance names. Can be empty if name_pattern is used., sourceInstanceTemplate: str # Specifies the instance template from which to create instances. You may combine sourceInstanceTemplate with instanceProperties to override specific values from an existing instance template. Bulk API follows the semantics of JSON Merge Patch described by RFC 7396. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate This field is optional.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/zones/{zone}/instances/{instance}\n@desc Deletes the specified Instance resource. For more information, see Deleting an instance.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instances/{instance}\n@desc Returns the specified Instance resource.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance resource to return.}\n@returns(200) {advancedMachineFeatures: map{enableNestedVirtualization: bool, enableUefiNetworking: bool, threadsPerCore: int(int32), visibleCoreCount: int(int32)}, canIpForward: bool, confidentialInstanceConfig: map{enableConfidentialCompute: bool}, cpuPlatform: str, creationTimestamp: str, deletionProtection: bool, description: str, disks: [map], displayDevice: map{enableDisplay: bool}, fingerprint: str(byte), guestAccelerators: [map], hostname: str, id: str(uint64), keyRevocationActionType: str, kind: str, labelFingerprint: str(byte), labels: map, lastStartTimestamp: str, lastStopTimestamp: str, lastSuspendedTimestamp: str, machineType: str, metadata: map{fingerprint: str(byte), items: [map], kind: str}, minCpuPlatform: str, name: str, networkInterfaces: [map], networkPerformanceConfig: map{totalEgressBandwidthTier: str}, params: map{resourceManagerTags: map}, privateIpv6GoogleAccess: str, reservationAffinity: map{consumeReservationType: str, key: str, values: [str]}, resourcePolicies: [str], resourceStatus: map{physicalHost: str}, satisfiesPzs: bool, scheduling: map{automaticRestart: bool, instanceTerminationAction: str, locationHint: str, minNodeCpus: int(int32), nodeAffinities: [map], onHostMaintenance: str, preemptible: bool, provisioningModel: str}, selfLink: str, serviceAccounts: [map], shieldedInstanceConfig: map{enableIntegrityMonitoring: bool, enableSecureBoot: bool, enableVtpm: bool}, shieldedInstanceIntegrityPolicy: map{updateAutoLearnPolicy: bool}, sourceMachineImage: str, sourceMachineImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, startRestricted: bool, status: str, statusMessage: str, tags: map{fingerprint: str(byte), items: [str]}, zone: str} # Successful response\n\n@endpoint PUT /projects/{project}/zones/{zone}/instances/{instance}\n@desc Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance resource to update.}\n@optional {minimalAction: str(INVALID/NO_EFFECT/REFRESH/RESTART) # Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require., mostDisruptiveAllowedAction: str(INVALID/NO_EFFECT/REFRESH/RESTART) # Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., advancedMachineFeatures: map{enableNestedVirtualization: bool, enableUefiNetworking: bool, threadsPerCore: int(int32), visibleCoreCount: int(int32)} # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled)., canIpForward: bool # 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 ., confidentialInstanceConfig: map{enableConfidentialCompute: bool} # A set of Confidential Instance options., cpuPlatform: str # [Output Only] The CPU platform used by this instance., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., deletionProtection: bool # Whether the resource should be protected against deletion., description: str # An optional description of this resource. Provide this property when you create the resource., disks: [map{architecture: str, autoDelete: bool, boot: bool, deviceName: str, diskEncryptionKey: map, diskSizeGb: str(int64), forceAttach: bool, guestOsFeatures: [map], index: int(int32), initializeParams: map, interface: str, kind: str, licenses: [str], mode: str, shieldedInstanceInitialState: map, source: str, type: str}] # Array of disks associated with this instance. Persistent disks must be created before you can assign them., displayDevice: map{enableDisplay: bool} # A set of Display Device options, fingerprint: str(byte) # Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance., guestAccelerators: [map{acceleratorCount: int(int32), acceleratorType: str}] # A list of the type and count of accelerator cards attached to the instance., hostname: str # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., keyRevocationActionType: str(KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED/NONE/STOP) # KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified., kind: str=compute#instance # [Output Only] Type of the resource. Always compute#instance for instances., labelFingerprint: str(byte) # A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance., labels: map # Labels to apply to this instance. These can be later modified by the setLabels method., lastStartTimestamp: str # [Output Only] Last start timestamp in RFC3339 text format., lastStopTimestamp: str # [Output Only] Last stop timestamp in RFC3339 text format., lastSuspendedTimestamp: str # [Output Only] Last suspended timestamp in RFC3339 text format., machineType: str # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types., metadata: map{fingerprint: str(byte), items: [map], kind: str} # A metadata key/value entry., minCpuPlatform: str # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\"., name: str # 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: [map{accessConfigs: [map], aliasIpRanges: [map], fingerprint: str(byte), internalIpv6PrefixLength: int(int32), ipv6AccessConfigs: [map], ipv6AccessType: str, ipv6Address: str, kind: str, name: str, network: str, networkAttachment: str, networkIP: str, nicType: str, queueCount: int(int32), stackType: str, subnetwork: str}] # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance., networkPerformanceConfig: map{totalEgressBandwidthTier: str}, params: map{resourceManagerTags: map} # Additional instance params., privateIpv6GoogleAccess: str(ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE/ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE/INHERIT_FROM_SUBNETWORK) # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default., reservationAffinity: map{consumeReservationType: str, key: str, values: [str]} # Specifies the reservations that this instance can consume from., resourcePolicies: [str] # Resource policies applied to this instance., resourceStatus: map{physicalHost: str} # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls., satisfiesPzs: bool # [Output Only] Reserved for future use., scheduling: map{automaticRestart: bool, instanceTerminationAction: str, locationHint: str, minNodeCpus: int(int32), nodeAffinities: [map], onHostMaintenance: str, preemptible: bool, provisioningModel: str} # Sets the scheduling options for an Instance., selfLink: str # [Output Only] Server-defined URL for this resource., serviceAccounts: [map{email: str, scopes: [str]}] # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information., shieldedInstanceConfig: map{enableIntegrityMonitoring: bool, enableSecureBoot: bool, enableVtpm: bool} # A set of Shielded Instance options., shieldedInstanceIntegrityPolicy: map{updateAutoLearnPolicy: bool} # The policy describes the baseline against which Instance boot integrity is measured., sourceMachineImage: str # Source machine image, sourceMachineImageEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, startRestricted: bool # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity., status: str(DEPROVISIONING/PROVISIONING/REPAIRING/RUNNING/STAGING/STOPPED/STOPPING/SUSPENDED/SUSPENDING/TERMINATED) # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle., statusMessage: str # [Output Only] An optional, human-readable explanation of the status., tags: map{fingerprint: str(byte), items: [str]} # A set of instance tags., zone: str # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig\n@desc Adds an access config to an instance's network interface.\n@required {zone: str # The name of the zone for this request., instance: str # The instance name for this request., networkInterface: str # The name of the network interface to add to this instance.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., externalIpv6: str # Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork., externalIpv6PrefixLength: int(int32) # Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range., kind: str=compute#accessConfig # [Output Only] Type of the resource. Always compute#accessConfig for access configs., name: str # The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6., natIP: str # Applies to accessConfigs (IPv4) only. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance., networkTier: str(FIXED_STANDARD/PREMIUM/STANDARD/STANDARD_OVERRIDES_FIXED_STANDARD) # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP., publicPtrDomainName: str # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range., setPublicPtr: bool # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated., type: str(DIRECT_IPV6/ONE_TO_ONE_NAT) # The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies\n@desc Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.\n@required {zone: str # The name of the zone for this request., instance: str # The instance name for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., resourcePolicies: [str] # Resource policies to be added to this instance.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/attachDisk\n@desc Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.\n@required {zone: str # The name of the zone for this request., instance: str # The instance name for this request.}\n@optional {forceAttach: bool # Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., architecture: str(ARCHITECTURE_UNSPECIFIED/ARM64/X86_64) # [Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64., autoDelete: bool # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance)., boot: bool # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem., deviceName: str # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks., diskEncryptionKey: map{kmsKeyName: str, kmsKeyServiceAccount: str, rawKey: str, rsaEncryptedKey: str, sha256: str}, diskSizeGb: str(int64) # The size of the disk in GB., forceAttach: bool # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error., guestOsFeatures: [map{type: str}] # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options., index: int(int32) # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number., initializeParams: map{architecture: str, description: str, diskName: str, diskSizeGb: str(int64), diskType: str, labels: map, licenses: [str], onUpdateAction: str, provisionedIops: str(int64), replicaZones: [str], resourceManagerTags: map, resourcePolicies: [str], sourceImage: str, sourceImageEncryptionKey: map, sourceSnapshot: str, sourceSnapshotEncryptionKey: map} # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This field is persisted and returned for instanceTemplate and not returned in the context of instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both., interface: str(NVME/SCSI) # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. For most machine types, the default is SCSI. Local SSDs can use either NVME or SCSI. In certain configurations, persistent disks can use NVMe. For more information, see About persistent disks., kind: str=compute#attachedDisk # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks., licenses: [str] # [Output Only] Any valid publicly visible licenses., mode: str(READ_ONLY/READ_WRITE) # 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., shieldedInstanceInitialState: map{dbs: [map], dbxs: [map], keks: [map], pk: map} # Initial State for shielded instance, these are public keys which are safe to store in public, source: str # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk., type: str(PERSISTENT/SCRATCH) # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig\n@desc Deletes an access config from an instance's network interface.\n@required {zone: str # The name of the zone for this request., instance: str # The instance name for this request., accessConfig: str # The name of the access config to delete., networkInterface: str # The name of the network interface.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/detachDisk\n@desc Detaches a disk from an instance.\n@required {zone: str # The name of the zone for this request., instance: str # Instance name for this request., deviceName: str # The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls\n@desc Returns effective firewalls applied to an interface of the instance.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance scoping this request., networkInterface: str # The name of the network interface to get the effective firewalls.}\n@returns(200) {firewallPolicys: [map], firewalls: [map]} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes\n@desc Returns the specified guest attributes entry.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance scoping this request.}\n@optional {queryPath: str # Specifies the guest attributes path to be queried., variableKey: str # Specifies the key for the guest attributes entry.}\n@returns(200) {kind: str, queryPath: str, queryValue: map{items: [map]}, selfLink: str, variableKey: str, variableValue: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity\n@desc Returns the Shielded Instance Identity of an instance\n@required {zone: str # The name of the zone for this request., instance: str # Name or id of the instance scoping this request.}\n@returns(200) {encryptionKey: map{ekCert: str, ekPub: str}, kind: str, signingKey: map{ekCert: str, ekPub: str}} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instances/{instance}/referrers\n@desc Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies\n@desc Removes resource policies from an instance.\n@required {zone: str # The name of the zone for this request., instance: str # The instance name for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., resourcePolicies: [str] # Resource policies to be removed from this instance.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/reset\n@desc Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/resume\n@desc Resumes an instance that was suspended using the instances().suspend method.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance resource to resume.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instances/{instance}/screenshot\n@desc Returns the screenshot from the specified instance.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance scoping this request.}\n@returns(200) {contents: str, kind: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt\n@desc Sends diagnostic interrupt to the instance.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance scoping this request.}\n@returns(200) Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instances/{instance}/serialPort\n@desc Returns the last 1 MB of serial port output from the specified instance.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance for this request.}\n@optional {port: int # Specifies which COM or serial port to retrieve data from., start: str # Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`. If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value. You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console.}\n@returns(200) {contents: str, kind: str, next: str(int64), selfLink: str, start: str(int64)} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete\n@desc Sets the auto-delete flag for a disk attached to an instance.\n@required {zone: str # The name of the zone for this request., instance: str # The instance name for this request., autoDelete: bool # Whether to auto-delete the disk when the instance is deleted., deviceName: str # The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/setLabels\n@desc Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., labelFingerprint: str(byte) # Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels., labels: map}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/setMachineResources\n@desc Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., guestAccelerators: [map{acceleratorCount: int(int32), acceleratorType: str}] # A list of the type and count of accelerator cards attached to the instance.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/setMachineType\n@desc Changes the machine type for a stopped instance to the machine type specified in the request.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., machineType: str # 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}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/setMetadata\n@desc Sets metadata for the specified instance to the data included in the request.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., fingerprint: str(byte) # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource., items: [map{key: str, value: str}] # Array of key/value pairs. The total size of all keys and values must be less than 512 KB., kind: str=compute#metadata # [Output Only] Type of the resource. Always compute#metadata for metadata.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform\n@desc Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., minCpuPlatform: str # Minimum cpu/platform this instance should be started at.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/setName\n@desc Sets name of an instance.\n@required {zone: str # The name of the zone for this request., instance: str # The instance name for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., currentName: str # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name., name: str # The name to be applied to the instance. Needs to be RFC 1035 compliant.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/setScheduling\n@desc Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, see Set VM host maintenance policy.\n@required {zone: str # The name of the zone for this request., instance: str # Instance name for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., automaticRestart: bool # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine., instanceTerminationAction: str(DELETE/INSTANCE_TERMINATION_ACTION_UNSPECIFIED/STOP) # Specifies the termination action for the instance., locationHint: str # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API., minNodeCpus: int(int32) # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node., nodeAffinities: [map{key: str, operator: str, values: [str]}] # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity., onHostMaintenance: str(MIGRATE/TERMINATE) # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy., preemptible: bool # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states., provisioningModel: str(SPOT/STANDARD) # Specifies the provisioning model of the instance.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount\n@desc Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance resource to start.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., email: str # Email address of the service account., scopes: [str] # The list of scopes to be made available for this service account.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PATCH /projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy\n@desc Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {zone: str # The name of the zone for this request., instance: str # Name or id of the instance scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., updateAutoLearnPolicy: bool # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/setTags\n@desc Sets network tags for the specified instance to the data included in the request.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., fingerprint: str(byte) # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. To see the latest fingerprint, make get() request to the instance., items: [str] # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent\n@desc Simulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance scoping this request.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/start\n@desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance resource to start.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey\n@desc Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance resource to start.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., disks: [map{diskEncryptionKey: map, source: str}] # Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/stop\n@desc Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance resource to stop.}\n@optional {discardLocalSsd: bool # If true, discard the contents of any attached localSSD partitions. Default value is false., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/suspend\n@desc This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances have no compute costs (cores or RAM), and incur only storage charges for the saved VM memory and localSSD data. Any charged resources the virtual machine was using, such as persistent disks and static IP addresses, will continue to be charged while the instance is suspended. For more information, see Suspending and resuming an instance.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance resource to suspend.}\n@optional {discardLocalSsd: bool # If true, discard the contents of any attached localSSD partitions. Default value is false., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig\n@desc Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {zone: str # The name of the zone for this request., instance: str # The instance name for this request., networkInterface: str # The name of the network interface where the access config is attached.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., externalIpv6: str # Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork., externalIpv6PrefixLength: int(int32) # Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range., kind: str=compute#accessConfig # [Output Only] Type of the resource. Always compute#accessConfig for access configs., name: str # The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6., natIP: str # Applies to accessConfigs (IPv4) only. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance., networkTier: str(FIXED_STANDARD/PREMIUM/STANDARD/STANDARD_OVERRIDES_FIXED_STANDARD) # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP., publicPtrDomainName: str # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range., setPublicPtr: bool # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated., type: str(DIRECT_IPV6/ONE_TO_ONE_NAT) # The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PATCH /projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice\n@desc Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {zone: str # The name of the zone for this request., instance: str # Name of the instance scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., enableDisplay: bool # Defines whether the instance has Display enabled.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PATCH /projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface\n@desc Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.\n@required {zone: str # The name of the zone for this request., instance: str # The instance name for this request., networkInterface: str # The name of the network interface to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., accessConfigs: [map{externalIpv6: str, externalIpv6PrefixLength: int(int32), kind: str, name: str, natIP: str, networkTier: str, publicPtrDomainName: str, setPublicPtr: bool, type: str}] # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access., aliasIpRanges: [map{ipCidrRange: str, subnetworkRangeName: str}] # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks., fingerprint: str(byte) # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date., internalIpv6PrefixLength: int(int32) # The prefix length of the primary internal IPv6 range., ipv6AccessConfigs: [map{externalIpv6: str, externalIpv6PrefixLength: int(int32), kind: str, name: str, natIP: str, networkTier: str, publicPtrDomainName: str, setPublicPtr: bool, type: str}] # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access., ipv6AccessType: str(EXTERNAL/INTERNAL) # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6., ipv6Address: str # An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork., kind: str=compute#networkInterface # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces., name: str # [Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0., network: str # URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default, networkAttachment: str # The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}., networkIP: str # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system., nicType: str(GVNIC/UNSPECIFIED_NIC_TYPE/VIRTIO_NET) # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet., queueCount: int(int32) # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users., stackType: str(IPV4_IPV6/IPV4_ONLY) # The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations., subnetwork: str # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint PATCH /projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig\n@desc Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.\n@required {zone: str # The name of the zone for this request., instance: str # Name or id of the instance scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., enableIntegrityMonitoring: bool # Defines whether the instance has integrity monitoring enabled. Enabled by default., enableSecureBoot: bool # Defines whether the instance has Secure Boot enabled. Disabled by default., enableVtpm: bool # Defines whether the instance has the vTPM enabled. Enabled by default.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection\n@desc Sets deletion protection on the instance.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {deletionProtection: bool # Whether the resource should be protected against deletion., requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/machineTypes\n@desc Retrieves a list of machine types available to the specified project.\n@required {zone: str # The name of the zone for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/machineTypes/{machineType}\n@desc Returns the specified machine type.\n@required {zone: str # The name of the zone for this request., machineType: str # Name of the machine type to return.}\n@returns(200) {accelerators: [map], creationTimestamp: str, deprecated: map{deleted: str, deprecated: str, obsolete: str, replacement: str, state: str}, description: str, guestCpus: int(int32), id: str(uint64), imageSpaceGb: int(int32), isSharedCpu: bool, kind: str, maximumPersistentDisks: int(int32), maximumPersistentDisksSizeGb: str(int64), memoryMb: int(int32), name: str, scratchDisks: [map], selfLink: str, zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/networkEndpointGroups\n@desc Retrieves the list of network endpoint groups that are located in the specified project and zone.\n@required {zone: str # The name of the zone where the network endpoint group is located. It should comply with RFC1035.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/networkEndpointGroups\n@desc Creates a network endpoint group in the specified project using the parameters that are included in the request.\n@required {zone: str # The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., annotations: map # Metadata defined as annotations on the network endpoint group., appEngine: map{service: str, urlMask: str, version: str} # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG., cloudFunction: map{function: str, urlMask: str} # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG., cloudRun: map{service: str, tag: str, urlMask: str} # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., defaultPort: int(int32) # The default port used if the port number is not specified in the network endpoint., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#networkEndpointGroup # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group., name: str # 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., network: str # The URL of the network to which all network endpoints in the NEG belong. Uses \"default\" project network if unspecified., networkEndpointType: str(GCE_VM_IP/GCE_VM_IP_PORT/INTERNET_FQDN_PORT/INTERNET_IP_PORT/NON_GCP_PRIVATE_IP_PORT/PRIVATE_SERVICE_CONNECT/SERVERLESS) # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT., pscData: map{consumerPscAddress: str, pscConnectionId: str(uint64), pscConnectionStatus: str} # All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT., pscTargetService: str # The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: \"asia-northeast3-cloudkms.googleapis.com\", region: str # [Output Only] The URL of the region where the network endpoint group is located., selfLink: str # [Output Only] Server-defined URL for the resource., size: int(int32) # [Output only] Number of network endpoints in the network endpoint group., subnetwork: str # Optional URL of the subnetwork to which all network endpoints in the NEG belong., zone: str # [Output Only] The URL of the zone where the network endpoint group is located.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}\n@desc Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.\n@required {zone: str # The name of the zone where the network endpoint group is located. It should comply with RFC1035., networkEndpointGroup: str # The name of the network endpoint group to delete. It should comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}\n@desc Returns the specified network endpoint group.\n@required {zone: str # The name of the zone where the network endpoint group is located. It should comply with RFC1035., networkEndpointGroup: str # The name of the network endpoint group. It should comply with RFC1035.}\n@returns(200) {annotations: map, appEngine: map{service: str, urlMask: str, version: str}, cloudFunction: map{function: str, urlMask: str}, cloudRun: map{service: str, tag: str, urlMask: str}, creationTimestamp: str, defaultPort: int(int32), description: str, id: str(uint64), kind: str, name: str, network: str, networkEndpointType: str, pscData: map{consumerPscAddress: str, pscConnectionId: str(uint64), pscConnectionStatus: str}, pscTargetService: str, region: str, selfLink: str, size: int(int32), subnetwork: str, zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints\n@desc Attach a list of network endpoints to the specified network endpoint group.\n@required {zone: str # The name of the zone where the network endpoint group is located. It should comply with RFC1035., networkEndpointGroup: str # The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., networkEndpoints: [map{annotations: map, fqdn: str, instance: str, ipAddress: str, port: int(int32)}] # The list of network endpoints to be attached.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints\n@desc Detach a list of network endpoints from the specified network endpoint group.\n@required {zone: str # The name of the zone where the network endpoint group is located. It should comply with RFC1035., networkEndpointGroup: str # The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., networkEndpoints: [map{annotations: map, fqdn: str, instance: str, ipAddress: str, port: int(int32)}] # The list of network endpoints to be detached.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints\n@desc Lists the network endpoints in the specified network endpoint group.\n@required {zone: str # The name of the zone where the network endpoint group is located. It should comply with RFC1035., networkEndpointGroup: str # The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false., healthStatus: str(SHOW/SKIP) # Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/nodeGroups\n@desc Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.\n@required {zone: str # The name of the zone for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/nodeGroups\n@desc Creates a NodeGroup resource in the specified project using the data included in the request.\n@required {zone: str # The name of the zone for this request., initialNodeCount: int # Initial count of nodes in the node group.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoscalingPolicy: map{maxNodes: int(int32), minNodes: int(int32), mode: str}, creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte), id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#nodeGroup # [Output Only] The type of the resource. Always compute#nodeGroup for node group., locationHint: str # An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate., maintenancePolicy: str(DEFAULT/MAINTENANCE_POLICY_UNSPECIFIED/MIGRATE_WITHIN_NODE_GROUP/RESTART_IN_PLACE) # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies., maintenanceWindow: map{maintenanceDuration: map, startTime: str} # Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window., name: str # 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., nodeTemplate: str # URL of the node template to create the node group from., selfLink: str # [Output Only] Server-defined URL for the resource., shareSettings: map{projectMap: map, shareType: str} # The share setting for reservations and sole tenancy node groups., size: int(int32) # [Output Only] The total number of nodes in the node group., status: str(CREATING/DELETING/INVALID/READY), zone: str # [Output Only] The name of the zone where the node group resides, such as us-central1-a.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}\n@desc Deletes the specified NodeGroup resource.\n@required {zone: str # The name of the zone for this request., nodeGroup: str # Name of the NodeGroup resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}\n@desc Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the \"nodes\" field should not be used. Use nodeGroups.listNodes instead.\n@required {zone: str # The name of the zone for this request., nodeGroup: str # Name of the node group to return.}\n@returns(200) {autoscalingPolicy: map{maxNodes: int(int32), minNodes: int(int32), mode: str}, creationTimestamp: str, description: str, fingerprint: str(byte), id: str(uint64), kind: str, locationHint: str, maintenancePolicy: str, maintenanceWindow: map{maintenanceDuration: map{nanos: int(int32), seconds: str(int64)}, startTime: str}, name: str, nodeTemplate: str, selfLink: str, shareSettings: map{projectMap: map, shareType: str}, size: int(int32), status: str, zone: str} # Successful response\n\n@endpoint PATCH /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}\n@desc Updates the specified node group.\n@required {zone: str # The name of the zone for this request., nodeGroup: str # Name of the NodeGroup resource to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., autoscalingPolicy: map{maxNodes: int(int32), minNodes: int(int32), mode: str}, creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., fingerprint: str(byte), id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#nodeGroup # [Output Only] The type of the resource. Always compute#nodeGroup for node group., locationHint: str # An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate., maintenancePolicy: str(DEFAULT/MAINTENANCE_POLICY_UNSPECIFIED/MIGRATE_WITHIN_NODE_GROUP/RESTART_IN_PLACE) # Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies., maintenanceWindow: map{maintenanceDuration: map, startTime: str} # Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window., name: str # 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., nodeTemplate: str # URL of the node template to create the node group from., selfLink: str # [Output Only] Server-defined URL for the resource., shareSettings: map{projectMap: map, shareType: str} # The share setting for reservations and sole tenancy node groups., size: int(int32) # [Output Only] The total number of nodes in the node group., status: str(CREATING/DELETING/INVALID/READY), zone: str # [Output Only] The name of the zone where the node group resides, such as us-central1-a.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes\n@desc Adds specified number of nodes to the node group.\n@required {zone: str # The name of the zone for this request., nodeGroup: str # Name of the NodeGroup resource.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., additionalNodeCount: int(int32) # Count of additional nodes to be added to the node group.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes\n@desc Deletes specified nodes from the node group.\n@required {zone: str # The name of the zone for this request., nodeGroup: str # Name of the NodeGroup resource whose nodes will be deleted.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., nodes: [str] # Names of the nodes to delete.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes\n@desc Lists nodes in the node group.\n@required {zone: str # The name of the zone for this request., nodeGroup: str # Name of the NodeGroup resource whose nodes you want to list.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate\n@desc Updates the node template of the node group.\n@required {zone: str # The name of the zone for this request., nodeGroup: str # Name of the NodeGroup resource to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., nodeTemplate: str # Full or partial URL of the node template resource to be updated for this node group.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent\n@desc Simulates maintenance event on specified nodes from the node group.\n@required {zone: str # The name of the zone for this request., nodeGroup: str # Name of the NodeGroup resource whose nodes will go under maintenance simulation.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., nodes: [str] # Names of the nodes to go under maintenance simulation.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/nodeTypes\n@desc Retrieves a list of node types available to the specified project.\n@required {zone: str # The name of the zone for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/nodeTypes/{nodeType}\n@desc Returns the specified node type.\n@required {zone: str # The name of the zone for this request., nodeType: str # Name of the node type to return.}\n@returns(200) {cpuPlatform: str, creationTimestamp: str, deprecated: map{deleted: str, deprecated: str, obsolete: str, replacement: str, state: str}, description: str, guestCpus: int(int32), id: str(uint64), kind: str, localSsdGb: int(int32), memoryMb: int(int32), name: str, selfLink: str, zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/operations\n@desc Retrieves a list of Operation resources contained within the specified zone.\n@required {zone: str # Name of the zone for request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint DELETE /projects/{project}/zones/{zone}/operations/{operation}\n@desc Deletes the specified zone-specific Operations resource.\n@required {zone: str # Name of the zone for this request., operation: str # Name of the Operations resource to delete.}\n@returns(200) Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/operations/{operation}\n@desc Retrieves the specified zone-specific Operations resource.\n@required {zone: str # Name of the zone for this request., operation: str # Name of the Operations resource to return.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/operations/{operation}/wait\n@desc Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`.\n@required {zone: str # Name of the zone for this request., operation: str # Name of the Operations resource to return.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/reservations\n@desc A list of all the reservations that have been configured for the specified project in specified zone.\n@required {zone: str # Name of the zone for this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/reservations\n@desc Creates a new reservation. For more information, read Reserving zonal resources.\n@required {zone: str # Name of the zone for this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., commitment: str # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#reservation # [Output Only] Type of the resource. Always compute#reservations for reservations., name: str # 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., resourcePolicies: map # Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation., resourceStatus: map{specificSkuAllocation: map} # [Output Only] Contains output only fields., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined fully-qualified URL for this resource., shareSettings: map{projectMap: map, shareType: str} # The share setting for reservations and sole tenancy node groups., specificReservation: map{assuredCount: str(int64), count: str(int64), inUseCount: str(int64), instanceProperties: map, sourceInstanceTemplate: str} # This reservation type allows to pre allocate specific instance configuration. Next ID: 6, specificReservationRequired: bool # Indicates whether the reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation., status: str(CREATING/DELETING/INVALID/READY/UPDATING) # [Output Only] The status of the reservation., zone: str # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/zones/{zone}/reservations/{reservation}\n@desc Deletes the specified reservation.\n@required {zone: str # Name of the zone for this request., reservation: str # Name of the reservation to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/reservations/{reservation}\n@desc Retrieves information about the specified reservation.\n@required {zone: str # Name of the zone for this request., reservation: str # Name of the reservation to retrieve.}\n@returns(200) {commitment: str, creationTimestamp: str, description: str, id: str(uint64), kind: str, name: str, resourcePolicies: map, resourceStatus: map{specificSkuAllocation: map{sourceInstanceTemplateId: str}}, satisfiesPzs: bool, selfLink: str, shareSettings: map{projectMap: map, shareType: str}, specificReservation: map{assuredCount: str(int64), count: str(int64), inUseCount: str(int64), instanceProperties: map{guestAccelerators: [map], localSsds: [map], locationHint: str, machineType: str, minCpuPlatform: str}, sourceInstanceTemplate: str}, specificReservationRequired: bool, status: str, zone: str} # Successful response\n\n@endpoint PATCH /projects/{project}/zones/{zone}/reservations/{reservation}\n@desc Update share settings of the reservation.\n@required {zone: str # Name of the zone for this request., reservation: str # Name of the reservation to update.}\n@optional {paths: [str], requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., updateMask: str # Update_mask indicates fields to be updated as part of this request., commitment: str # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., kind: str=compute#reservation # [Output Only] Type of the resource. Always compute#reservations for reservations., name: str # 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., resourcePolicies: map # Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation., resourceStatus: map{specificSkuAllocation: map} # [Output Only] Contains output only fields., satisfiesPzs: bool # [Output Only] Reserved for future use., selfLink: str # [Output Only] Server-defined fully-qualified URL for this resource., shareSettings: map{projectMap: map, shareType: str} # The share setting for reservations and sole tenancy node groups., specificReservation: map{assuredCount: str(int64), count: str(int64), inUseCount: str(int64), instanceProperties: map, sourceInstanceTemplate: str} # This reservation type allows to pre allocate specific instance configuration. Next ID: 6, specificReservationRequired: bool # Indicates whether the reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation., status: str(CREATING/DELETING/INVALID/READY/UPDATING) # [Output Only] The status of the reservation., zone: str # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/reservations/{reservation}/resize\n@desc Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.\n@required {zone: str # Name of the zone for this request., reservation: str # Name of the reservation to update.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., specificSkuCount: str(int64) # Number of allocated resources can be resized with minimum = 1 and maximum = 1000.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy\n@desc Gets the access control policy for a resource. May be empty if no such policy or resource exists.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {optionsRequestedPolicyVersion: int # Requested IAM Policy version.}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy\n@desc Sets the access control policy on the specified resource. Replaces any existing policy.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {bindings: [map{bindingId: str, condition: map, members: [str], role: str}] # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings., etag: str(byte) # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag., policy: map{auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).}\n@returns(200) {auditConfigs: [map], bindings: [map], etag: str(byte), rules: [map], version: int(int32)} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions\n@desc Returns permissions that a caller has on the specified resource.\n@required {zone: str # The name of the zone for this request., resource: str # Name or id of the resource for this request.}\n@optional {permissions: [str] # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.}\n@returns(200) {permissions: [str]} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/targetInstances\n@desc Retrieves a list of TargetInstance resources available to the specified project and zone.\n@required {zone: str # Name of the zone scoping this request.}\n@optional {filter: str # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`., maxResults: int # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`), orderBy: str # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported., pageToken: str # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results., returnPartialSuccess: bool # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.}\n@returns(200) {id: str, items: [map], kind: str, nextPageToken: str, selfLink: str, warning: map{code: str, data: [map], message: str}} # Successful response\n\n@endpoint POST /projects/{project}/zones/{zone}/targetInstances\n@desc Creates a TargetInstance resource in the specified project and zone using the data included in the request.\n@required {zone: str # Name of the zone scoping this request.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000)., creationTimestamp: str # [Output Only] Creation timestamp in RFC3339 text format., description: str # An optional description of this resource. Provide this property when you create the resource., id: str(uint64) # [Output Only] The unique identifier for the resource. This identifier is defined by the server., instance: str # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance, kind: str=compute#targetInstance # [Output Only] The type of the resource. Always compute#targetInstance for target instances., name: str # 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., natPolicy: str # Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance., network: str # The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to., selfLink: str # [Output Only] Server-defined URL for the resource., zone: str # [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint DELETE /projects/{project}/zones/{zone}/targetInstances/{targetInstance}\n@desc Deletes the specified TargetInstance resource.\n@required {zone: str # Name of the zone scoping this request., targetInstance: str # Name of the TargetInstance resource to delete.}\n@optional {requestId: str # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).}\n@returns(200) {clientOperationId: str, creationTimestamp: str, description: str, endTime: str, error: map{errors: [map]}, httpErrorMessage: str, httpErrorStatusCode: int(int32), id: str(uint64), insertTime: str, kind: str, name: str, operationGroupId: str, operationType: str, progress: int(int32), region: str, selfLink: str, startTime: str, status: str, statusMessage: str, targetId: str(uint64), targetLink: str, user: str, warnings: [map], zone: str} # Successful response\n\n@endpoint GET /projects/{project}/zones/{zone}/targetInstances/{targetInstance}\n@desc Returns the specified TargetInstance resource.\n@required {zone: str # Name of the zone scoping this request., targetInstance: str # Name of the TargetInstance resource to return.}\n@returns(200) {creationTimestamp: str, description: str, id: str(uint64), instance: str, kind: str, name: str, natPolicy: str, network: str, selfLink: str, zone: str} # Successful response\n\n@endgroup\n\n@end\n"}