Blame - docs/dyn/compute_alpha.vpnGateways.html - platform/external/python/google-api-python-client

blob: 31f3f344edb55a6f168672990b7bb7dabaead0bf [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.vpnGateways.html">vpnGateways</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	78	<code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	79	<p class="firstline">Retrieves an aggregated list of VPN gateways.</p>
				80	<p class="toc_element">
				81	<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
				82	<p class="firstline">Retrieves the next page of results.</p>
				83	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	84	<code><a href="#close">close()</a></code></p>
				85	<p class="firstline">Close httplib2 connections.</p>
				86	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	87	<code><a href="#delete">delete(project, region, vpnGateway, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Deletes the specified VPN gateway.</p>
				89	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	90	<code><a href="#get">get(project, region, vpnGateway, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	91	<p class="firstline">Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.</p>
				92	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	93	<code><a href="#getStatus">getStatus(project, region, vpnGateway, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	94	<p class="firstline">Returns the status for the specified VPN gateway.</p>
				95	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	96	<code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Creates a VPN gateway in the specified project and region using the data included in the request.</p>
				98	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	99	<code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	100	<p class="firstline">Retrieves a list of VPN gateways available to the specified project and region.</p>
				101	<p class="toc_element">
				102	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				103	<p class="firstline">Retrieves the next page of results.</p>
				104	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	105	<code><a href="#setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	106	<p class="firstline">Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.</p>
				107	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	108	<code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	109	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				110	<h3>Method Details</h3>
				111	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	112	<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	113	<pre>Retrieves an aggregated list of VPN gateways.
				114
				115	Args:
				116	project: string, Project ID for this request. (required)
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	117	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be 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) ```
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	118	includeAllScopes: boolean, 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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	119	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	120	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	121	pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	122	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	123	x__xgafv: string, V1 error format.
				124	Allowed values
				125	1 - v1 error format
				126	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	127
				128	Returns:
				129	An object of the form:
				130
				131	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	132	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				133	"items": { # A list of VpnGateway resources.
				134	"a_key": { # [Output Only] Name of the scope containing this set of VPN gateways.
				135	"vpnGateways": [ # [Output Only] A list of VPN gateways contained in this scope.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	136	{ # Represents a HA VPN gateway. HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies .
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	137	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				138	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				139	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				140	"kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	141	"labelFingerprint": "A String", # 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 an VpnGateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	142	"labels": { # 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.
				143	"a_key": "A String",
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	144	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	145	"name": "A String", # 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.
				146	"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
				147	"region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
				148	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	149	"stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. If not specified, IPV4_ONLY will be used.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	150	"vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	151	{ # A VPN gateway interface.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	152	"id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	153	"interconnectAttachment": "A String", # URL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for IPsec-encrypted Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource. Not currently available publicly.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	154	"ipAddress": "A String", # [Output Only] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For IPsec-encrypted Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non IPsec-encrypted Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	155	},
				156	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	157	},
				158	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	159	"warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
				160	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	161	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	162	{
				163	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				164	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				165	},
				166	],
				167	"message": "A String", # [Output Only] A human-readable description of the warning code.
				168	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	169	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	170	},
				171	"kind": "compute#vpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
				172	"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
				173	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				174	"unreachables": [ # [Output Only] Unreachable resources.
				175	"A String",
				176	],
				177	"warning": { # [Output Only] Informational warning message.
				178	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	179	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	180	{
				181	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				182	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				183	},
				184	],
				185	"message": "A String", # [Output Only] A human-readable description of the warning code.
				186	},
				187	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	188	</div>
				189
				190	<div class="method">
				191	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				192	<pre>Retrieves the next page of results.
				193
				194	Args:
				195	previous_request: The request for the previous page. (required)
				196	previous_response: The response from the request for the previous page. (required)
				197
				198	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	199	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	200	page. Returns None if there are no more items in the collection.
				201	</pre>
				202	</div>
				203
				204	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	205	<code class="details" id="close">close()</code>
				206	<pre>Close httplib2 connections.</pre>
				207	</div>
				208
				209	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	210	<code class="details" id="delete">delete(project, region, vpnGateway, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	211	<pre>Deletes the specified VPN gateway.
				212
				213	Args:
				214	project: string, Project ID for this request. (required)
				215	region: string, Name of the region for this request. (required)
				216	vpnGateway: string, Name of the VPN gateway to delete. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	217	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				218	x__xgafv: string, V1 error format.
				219	Allowed values
				220	1 - v1 error format
				221	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	222
				223	Returns:
				224	An object of the form:
				225
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	226	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	227	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				228	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				229	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				230	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				231	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				232	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	233	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	234	"code": "A String", # [Output Only] The error type identifier for this error.
				235	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				236	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	237	},
				238	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	239	},
				240	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				241	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				242	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				243	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				244	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	245	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				246	"a_key": "", # Properties of the object. Contains field @type with type URL.
				247	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	248	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	249	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	250	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				251	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				252	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				253	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				254	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				255	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				256	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				257	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				258	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				259	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				260	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				261	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				262	{
				263	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	264	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	265	{
				266	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				267	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				268	},
				269	],
				270	"message": "A String", # [Output Only] A human-readable description of the warning code.
				271	},
				272	],
				273	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				274	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	275	</div>
				276
				277	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	278	<code class="details" id="get">get(project, region, vpnGateway, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	279	<pre>Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.
				280
				281	Args:
				282	project: string, Project ID for this request. (required)
				283	region: string, Name of the region for this request. (required)
				284	vpnGateway: string, Name of the VPN gateway to return. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	285	x__xgafv: string, V1 error format.
				286	Allowed values
				287	1 - v1 error format
				288	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	289
				290	Returns:
				291	An object of the form:
				292
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	293	{ # Represents a HA VPN gateway. HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies .
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	294	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				295	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				296	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				297	"kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	298	"labelFingerprint": "A String", # 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 an VpnGateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	299	"labels": { # 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.
				300	"a_key": "A String",
				301	},
				302	"name": "A String", # 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.
				303	"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
				304	"region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
				305	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	306	"stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. If not specified, IPV4_ONLY will be used.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	307	"vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	308	{ # A VPN gateway interface.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	309	"id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	310	"interconnectAttachment": "A String", # URL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for IPsec-encrypted Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource. Not currently available publicly.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	311	"ipAddress": "A String", # [Output Only] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For IPsec-encrypted Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non IPsec-encrypted Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	312	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	313	],
				314	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	315	</div>
				316
				317	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	318	<code class="details" id="getStatus">getStatus(project, region, vpnGateway, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	319	<pre>Returns the status for the specified VPN gateway.
				320
				321	Args:
				322	project: string, Project ID for this request. (required)
				323	region: string, Name of the region for this request. (required)
				324	vpnGateway: string, Name of the VPN gateway to return. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	325	x__xgafv: string, V1 error format.
				326	Allowed values
				327	1 - v1 error format
				328	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	329
				330	Returns:
				331	An object of the form:
				332
				333	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	334	"result": {
				335	"vpnConnections": [ # List of VPN connection for this VpnGateway.
				336	{ # A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be a external VPN gateway or GCP VPN gateway.
				337	"peerExternalGateway": "A String", # URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.
				338	"peerGcpGateway": "A String", # URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.
				339	"state": { # Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway. # HighAvailabilityRequirementState for the VPN connection.
				340	"state": "A String", # Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET.
				341	"unsatisfiedReason": "A String", # Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	342	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	343	"tunnels": [ # List of VPN tunnels that are in this VPN connection.
				344	{ # Contains some information about a VPN tunnel.
				345	"localGatewayInterface": 42, # The VPN gateway interface this VPN tunnel is associated with.
				346	"peerGatewayInterface": 42, # The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or GCP VPN gateway.
				347	"tunnelUrl": "A String", # URL reference to the VPN tunnel.
				348	},
				349	],
				350	},
				351	],
				352	},
				353	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	354	</div>
				355
				356	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	357	<code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	358	<pre>Creates a VPN gateway in the specified project and region using the data included in the request.
				359
				360	Args:
				361	project: string, Project ID for this request. (required)
				362	region: string, Name of the region for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	363	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	364	The object takes the form of:
				365
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	366	{ # Represents a HA VPN gateway. HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies .
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	367	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				368	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				369	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				370	"kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	371	"labelFingerprint": "A String", # 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 an VpnGateway.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	372	"labels": { # 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.
				373	"a_key": "A String",
				374	},
				375	"name": "A String", # 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.
				376	"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
				377	"region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
				378	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	379	"stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. If not specified, IPV4_ONLY will be used.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	380	"vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	381	{ # A VPN gateway interface.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	382	"id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	383	"interconnectAttachment": "A String", # URL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for IPsec-encrypted Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource. Not currently available publicly.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	384	"ipAddress": "A String", # [Output Only] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For IPsec-encrypted Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non IPsec-encrypted Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	385	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	386	],
				387	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	388
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	389	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				390	x__xgafv: string, V1 error format.
				391	Allowed values
				392	1 - v1 error format
				393	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	394
				395	Returns:
				396	An object of the form:
				397
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	398	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	399	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				400	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				401	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				402	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				403	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				404	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	405	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	406	"code": "A String", # [Output Only] The error type identifier for this error.
				407	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				408	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	409	},
				410	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	411	},
				412	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				413	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				414	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				415	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				416	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	417	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				418	"a_key": "", # Properties of the object. Contains field @type with type URL.
				419	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	420	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	421	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	422	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				423	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				424	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				425	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				426	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				427	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				428	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				429	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				430	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				431	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				432	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				433	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				434	{
				435	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	436	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	437	{
				438	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				439	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				440	},
				441	],
				442	"message": "A String", # [Output Only] A human-readable description of the warning code.
				443	},
				444	],
				445	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				446	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	447	</div>
				448
				449	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	450	<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	451	<pre>Retrieves a list of VPN gateways available to the specified project and region.
				452
				453	Args:
				454	project: string, Project ID for this request. (required)
				455	region: string, Name of the region for this request. (required)
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	456	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be 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) ```
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	457	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	458	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	459	pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	460	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	461	x__xgafv: string, V1 error format.
				462	Allowed values
				463	1 - v1 error format
				464	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	465
				466	Returns:
				467	An object of the form:
				468
				469	{ # Contains a list of VpnGateway resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	470	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				471	"items": [ # A list of VpnGateway resources.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	472	{ # Represents a HA VPN gateway. HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies .
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	473	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				474	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				475	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				476	"kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	477	"labelFingerprint": "A String", # 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 an VpnGateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	478	"labels": { # 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.
				479	"a_key": "A String",
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	480	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	481	"name": "A String", # 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.
				482	"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
				483	"region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
				484	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
yoshi-code-bot	96afc04	2021-08-24 00:22:31 -0700	[diff] [blame]	485	"stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. If not specified, IPV4_ONLY will be used.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	486	"vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	487	{ # A VPN gateway interface.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	488	"id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	489	"interconnectAttachment": "A String", # URL of the VLAN attachment (interconnectAttachment) resource for this VPN gateway interface. When the value of this field is present, the VPN gateway is used for IPsec-encrypted Cloud Interconnect; all egress or ingress traffic for this VPN gateway interface goes through the specified VLAN attachment resource. Not currently available publicly.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	490	"ipAddress": "A String", # [Output Only] IP address for this VPN interface associated with the VPN gateway. The IP address could be either a regional external IP address or a regional internal IP address. The two IP addresses for a VPN gateway must be all regional external or regional internal IP addresses. There cannot be a mix of regional external IP addresses and regional internal IP addresses. For IPsec-encrypted Cloud Interconnect, the IP addresses for both interfaces could either be regional internal IP addresses or regional external IP addresses. For regular (non IPsec-encrypted Cloud Interconnect) HA VPN tunnels, the IP address must be a regional external IP address.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	491	},
				492	],
				493	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	494	],
				495	"kind": "compute#vpnGatewayList", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
				496	"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
				497	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				498	"warning": { # [Output Only] Informational warning message.
				499	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	500	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	501	{
				502	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				503	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				504	},
				505	],
				506	"message": "A String", # [Output Only] A human-readable description of the warning code.
				507	},
				508	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	509	</div>
				510
				511	<div class="method">
				512	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				513	<pre>Retrieves the next page of results.
				514
				515	Args:
				516	previous_request: The request for the previous page. (required)
				517	previous_response: The response from the request for the previous page. (required)
				518
				519	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	520	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	521	page. Returns None if there are no more items in the collection.
				522	</pre>
				523	</div>
				524
				525	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	526	<code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	527	<pre>Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.
				528
				529	Args:
				530	project: string, Project ID for this request. (required)
				531	region: string, The region for this request. (required)
				532	resource: string, Name or id of the resource for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	533	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	534	The object takes the form of:
				535
				536	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	537	"labelFingerprint": "A String", # 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.
				538	"labels": { # The labels to set for this resource.
				539	"a_key": "A String",
				540	},
				541	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	542
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	543	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				544	x__xgafv: string, V1 error format.
				545	Allowed values
				546	1 - v1 error format
				547	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	548
				549	Returns:
				550	An object of the form:
				551
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	552	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	553	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				554	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				555	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				556	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				557	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				558	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	559	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	560	"code": "A String", # [Output Only] The error type identifier for this error.
				561	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				562	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	563	},
				564	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	565	},
				566	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				567	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				568	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				569	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				570	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	571	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				572	"a_key": "", # Properties of the object. Contains field @type with type URL.
				573	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	574	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	575	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	576	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				577	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				578	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				579	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				580	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				581	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				582	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				583	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				584	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				585	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				586	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				587	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				588	{
				589	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	590	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	591	{
				592	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				593	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				594	},
				595	],
				596	"message": "A String", # [Output Only] A human-readable description of the warning code.
				597	},
				598	],
				599	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				600	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	601	</div>
				602
				603	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	604	<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	605	<pre>Returns permissions that a caller has on the specified resource.
				606
				607	Args:
				608	project: string, Project ID for this request. (required)
				609	region: string, The name of the region for this request. (required)
				610	resource: string, Name or id of the resource for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	611	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	612	The object takes the form of:
				613
				614	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	615	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				616	"A String",
				617	],
				618	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	619
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	620	x__xgafv: string, V1 error format.
				621	Allowed values
				622	1 - v1 error format
				623	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	624
				625	Returns:
				626	An object of the form:
				627
				628	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	629	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				630	"A String",
				631	],
				632	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	633	</div>
				634
				635	</body></html>