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

blob: 278d401440eec6f87500c05f2c517ea9b582f16e [file] [log] [blame]

Bu Sun Kim	6502091	2020-05-20 12:08:20 -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_v1.html">Compute Engine API</a> . <a href="compute_v1.vpnGateways.html">vpnGateways</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -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	6502091	2020-05-20 12:08:20 -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	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	87	<code><a href="#delete">delete(project, region, vpnGateway, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	88	<p class="firstline">Deletes the specified VPN gateway.</p>
				89	<p class="toc_element">
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	90	<code><a href="#get">get(project, region, vpnGateway, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -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	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	93	<code><a href="#getStatus">getStatus(project, region, vpnGateway, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	94	<p class="firstline">Returns the status for the specified VPN gateway.</p>
				95	<p class="toc_element">
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	96	<code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -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	0f0918f	2021-06-11 00:22:02 -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	6502091	2020-05-20 12:08:20 -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	0f0918f	2021-06-11 00:22:02 -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	6502091	2020-05-20 12:08:20 -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	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	108	<code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -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	0f0918f	2021-06-11 00:22:02 -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	6502091	2020-05-20 12:08:20 -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	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	117	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `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]	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.
				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	0f0918f	2021-06-11 00:22:02 -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	0f0918f	2021-06-11 00:22:02 -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	6502091	2020-05-20 12:08:20 -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	0f0918f	2021-06-11 00:22:02 -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	0f0918f	2021-06-11 00:22:02 -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	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	149	"vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	150	{ # A VPN gateway interface.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	151	"id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	152	"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]	153	"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]	154	},
				155	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	156	},
				157	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	158	"warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
				159	"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	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	160	"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]	161	{
				162	"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).
				163	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				164	},
				165	],
				166	"message": "A String", # [Output Only] A human-readable description of the warning code.
				167	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	168	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	169	},
				170	"kind": "compute#vpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
				171	"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.
				172	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				173	"unreachables": [ # [Output Only] Unreachable resources.
				174	"A String",
				175	],
				176	"warning": { # [Output Only] Informational warning message.
				177	"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	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	178	"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]	179	{
				180	"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).
				181	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				182	},
				183	],
				184	"message": "A String", # [Output Only] A human-readable description of the warning code.
				185	},
				186	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	187	</div>
				188
				189	<div class="method">
				190	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				191	<pre>Retrieves the next page of results.
				192
				193	Args:
				194	previous_request: The request for the previous page. (required)
				195	previous_response: The response from the request for the previous page. (required)
				196
				197	Returns:
				198	A request object that you can call 'execute()' on to request the next
				199	page. Returns None if there are no more items in the collection.
				200	</pre>
				201	</div>
				202
				203	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	204	<code class="details" id="close">close()</code>
				205	<pre>Close httplib2 connections.</pre>
				206	</div>
				207
				208	<div class="method">
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	209	<code class="details" id="delete">delete(project, region, vpnGateway, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	210	<pre>Deletes the specified VPN gateway.
				211
				212	Args:
				213	project: string, Project ID for this request. (required)
				214	region: string, Name of the region for this request. (required)
				215	vpnGateway: string, Name of the VPN gateway to delete. (required)
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	216	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).
				217	x__xgafv: string, V1 error format.
				218	Allowed values
				219	1 - v1 error format
				220	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	221
				222	Returns:
				223	An object of the form:
				224
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	225	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]	226	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				227	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				228	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				229	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				230	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				231	"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]	232	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	233	"code": "A String", # [Output Only] The error type identifier for this error.
				234	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				235	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	236	},
				237	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	238	},
				239	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				240	"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.
				241	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				242	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				243	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				244	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	245	"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]	246	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				247	"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.
				248	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				249	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				250	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				251	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				252	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				253	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				254	"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.
				255	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				256	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				257	{
				258	"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	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	259	"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]	260	{
				261	"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).
				262	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				263	},
				264	],
				265	"message": "A String", # [Output Only] A human-readable description of the warning code.
				266	},
				267	],
				268	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				269	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	270	</div>
				271
				272	<div class="method">
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	273	<code class="details" id="get">get(project, region, vpnGateway, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	274	<pre>Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.
				275
				276	Args:
				277	project: string, Project ID for this request. (required)
				278	region: string, Name of the region for this request. (required)
				279	vpnGateway: string, Name of the VPN gateway to return. (required)
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	280	x__xgafv: string, V1 error format.
				281	Allowed values
				282	1 - v1 error format
				283	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	284
				285	Returns:
				286	An object of the form:
				287
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	288	{ # 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]	289	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				290	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				291	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				292	"kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	293	"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]	294	"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.
				295	"a_key": "A String",
				296	},
				297	"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.
				298	"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
				299	"region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
				300	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	301	"vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	302	{ # A VPN gateway interface.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	303	"id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	304	"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]	305	"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]	306	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	307	],
				308	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	309	</div>
				310
				311	<div class="method">
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	312	<code class="details" id="getStatus">getStatus(project, region, vpnGateway, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	313	<pre>Returns the status for the specified VPN gateway.
				314
				315	Args:
				316	project: string, Project ID for this request. (required)
				317	region: string, Name of the region for this request. (required)
				318	vpnGateway: string, Name of the VPN gateway to return. (required)
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	319	x__xgafv: string, V1 error format.
				320	Allowed values
				321	1 - v1 error format
				322	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	323
				324	Returns:
				325	An object of the form:
				326
				327	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	328	"result": {
				329	"vpnConnections": [ # List of VPN connection for this VpnGateway.
				330	{ # 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.
				331	"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.
				332	"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.
				333	"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.
				334	"state": "A String", # Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET.
				335	"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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	336	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	337	"tunnels": [ # List of VPN tunnels that are in this VPN connection.
				338	{ # Contains some information about a VPN tunnel.
				339	"localGatewayInterface": 42, # The VPN gateway interface this VPN tunnel is associated with.
				340	"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.
				341	"tunnelUrl": "A String", # URL reference to the VPN tunnel.
				342	},
				343	],
				344	},
				345	],
				346	},
				347	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	348	</div>
				349
				350	<div class="method">
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	351	<code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	352	<pre>Creates a VPN gateway in the specified project and region using the data included in the request.
				353
				354	Args:
				355	project: string, Project ID for this request. (required)
				356	region: string, Name of the region for this request. (required)
				357	body: object, The request body.
				358	The object takes the form of:
				359
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	360	{ # 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]	361	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				362	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				363	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				364	"kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	365	"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]	366	"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.
				367	"a_key": "A String",
				368	},
				369	"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.
				370	"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
				371	"region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
				372	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	373	"vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	374	{ # A VPN gateway interface.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	375	"id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	376	"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]	377	"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]	378	},
				379	],
				380	}
				381
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	382	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).
				383	x__xgafv: string, V1 error format.
				384	Allowed values
				385	1 - v1 error format
				386	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	387
				388	Returns:
				389	An object of the form:
				390
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	391	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]	392	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				393	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				394	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				395	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				396	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				397	"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]	398	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	399	"code": "A String", # [Output Only] The error type identifier for this error.
				400	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				401	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	402	},
				403	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	404	},
				405	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				406	"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.
				407	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				408	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				409	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				410	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	411	"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]	412	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				413	"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.
				414	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				415	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				416	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				417	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				418	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				419	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				420	"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.
				421	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				422	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				423	{
				424	"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	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	425	"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]	426	{
				427	"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).
				428	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				429	},
				430	],
				431	"message": "A String", # [Output Only] A human-readable description of the warning code.
				432	},
				433	],
				434	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				435	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	436	</div>
				437
				438	<div class="method">
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	439	<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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	440	<pre>Retrieves a list of VPN gateways available to the specified project and region.
				441
				442	Args:
				443	project: string, Project ID for this request. (required)
				444	region: string, Name of the region for this request. (required)
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	445	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `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]	446	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	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	447	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]	448	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]	449	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	450	x__xgafv: string, V1 error format.
				451	Allowed values
				452	1 - v1 error format
				453	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	454
				455	Returns:
				456	An object of the form:
				457
				458	{ # Contains a list of VpnGateway resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	459	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				460	"items": [ # A list of VpnGateway resources.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	461	{ # 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]	462	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				463	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				464	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				465	"kind": "compute#vpnGateway", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	466	"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]	467	"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.
				468	"a_key": "A String",
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	469	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	470	"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.
				471	"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
				472	"region": "A String", # [Output Only] URL of the region where the VPN gateway resides.
				473	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	474	"vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	475	{ # A VPN gateway interface.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame]	476	"id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway.
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	477	"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]	478	"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]	479	},
				480	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	481	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	482	],
				483	"kind": "compute#vpnGatewayList", # [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
				484	"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.
				485	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				486	"warning": { # [Output Only] Informational warning message.
				487	"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	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	488	"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]	489	{
				490	"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).
				491	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				492	},
				493	],
				494	"message": "A String", # [Output Only] A human-readable description of the warning code.
				495	},
				496	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	497	</div>
				498
				499	<div class="method">
				500	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				501	<pre>Retrieves the next page of results.
				502
				503	Args:
				504	previous_request: The request for the previous page. (required)
				505	previous_response: The response from the request for the previous page. (required)
				506
				507	Returns:
				508	A request object that you can call 'execute()' on to request the next
				509	page. Returns None if there are no more items in the collection.
				510	</pre>
				511	</div>
				512
				513	<div class="method">
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	514	<code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	515	<pre>Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.
				516
				517	Args:
				518	project: string, Project ID for this request. (required)
				519	region: string, The region for this request. (required)
				520	resource: string, Name or id of the resource for this request. (required)
				521	body: object, The request body.
				522	The object takes the form of:
				523
				524	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	525	"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.
				526	"labels": { # The labels to set for this resource.
				527	"a_key": "A String",
				528	},
				529	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	530
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	531	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).
				532	x__xgafv: string, V1 error format.
				533	Allowed values
				534	1 - v1 error format
				535	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	536
				537	Returns:
				538	An object of the form:
				539
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	540	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]	541	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				542	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				543	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				544	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				545	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				546	"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]	547	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	548	"code": "A String", # [Output Only] The error type identifier for this error.
				549	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				550	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	551	},
				552	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	553	},
				554	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				555	"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.
				556	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				557	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				558	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				559	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	560	"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]	561	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				562	"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.
				563	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				564	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				565	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				566	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				567	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				568	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				569	"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.
				570	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				571	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				572	{
				573	"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	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	574	"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]	575	{
				576	"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).
				577	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				578	},
				579	],
				580	"message": "A String", # [Output Only] A human-readable description of the warning code.
				581	},
				582	],
				583	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				584	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	585	</div>
				586
				587	<div class="method">
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	588	<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	589	<pre>Returns permissions that a caller has on the specified resource.
				590
				591	Args:
				592	project: string, Project ID for this request. (required)
				593	region: string, The name of the region for this request. (required)
				594	resource: string, Name or id of the resource for this request. (required)
				595	body: object, The request body.
				596	The object takes the form of:
				597
				598	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	599	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				600	"A String",
				601	],
				602	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	603
yoshi-code-bot	0f0918f	2021-06-11 00:22:02 -0700	[diff] [blame^]	604	x__xgafv: string, V1 error format.
				605	Allowed values
				606	1 - v1 error format
				607	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	608
				609	Returns:
				610	An object of the form:
				611
				612	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	613	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				614	"A String",
				615	],
				616	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	617	</div>
				618
				619	</body></html>