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

blob: edc7a310110bd688b9ae3e2c36dbc734591d8bb7 [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.externalVpnGateways.html">externalVpnGateways</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	81	<code><a href="#delete">delete(project, externalVpnGateway, requestId=None)</a></code></p>
				82	<p class="firstline">Deletes the specified externalVpnGateway.</p>
				83	<p class="toc_element">
				84	<code><a href="#get">get(project, externalVpnGateway)</a></code></p>
				85	<p class="firstline">Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.</p>
				86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Creates a ExternalVpnGateway in the specified project using the data included in the request.</p>
				89	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	90	<code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	91	<p class="firstline">Retrieves the list of ExternalVpnGateway available to the specified project.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#setLabels">setLabels(project, resource, body=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.</p>
				98	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	100	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				101	<h3>Method Details</h3>
				102	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	103	<code class="details" id="close">close()</code>
				104	<pre>Close httplib2 connections.</pre>
				105	</div>
				106
				107	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	108	<code class="details" id="delete">delete(project, externalVpnGateway, requestId=None)</code>
				109	<pre>Deletes the specified externalVpnGateway.
				110
				111	Args:
				112	project: string, Project ID for this request. (required)
				113	externalVpnGateway: string, Name of the externalVpnGateways to delete. (required)
				114	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.
				115
				116	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				117
				118	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				119
				120	Returns:
				121	An object of the form:
				122
				123	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	124	#
				125	# Google Compute Engine has three Operation resources:
				126	#
				127	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				128	#
				129	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				130	#
				131	# Operations can be global, regional or zonal.
				132	# - For global operations, use the `globalOperations` resource.
				133	# - For regional operations, use the `regionOperations` resource.
				134	# - For zonal operations, use the `zonalOperations` resource.
				135	#
				136	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				137	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				138	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				139	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				140	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				141	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				142	"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]	143	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	144	"code": "A String", # [Output Only] The error type identifier for this error.
				145	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				146	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	147	},
				148	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	149	},
				150	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				151	"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.
				152	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				153	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				154	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				155	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	156	"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]	157	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				158	"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.
				159	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				160	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				161	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				162	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				163	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				164	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				165	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				166	"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.
				167	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				168	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				169	{
				170	"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.
				171	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				172	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				173	{
				174	"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).
				175	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				176	},
				177	],
				178	"message": "A String", # [Output Only] A human-readable description of the warning code.
				179	},
				180	],
				181	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				182	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	183	</div>
				184
				185	<div class="method">
				186	<code class="details" id="get">get(project, externalVpnGateway)</code>
				187	<pre>Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.
				188
				189	Args:
				190	project: string, Project ID for this request. (required)
				191	externalVpnGateway: string, Name of the externalVpnGateway to return. (required)
				192
				193	Returns:
				194	An object of the form:
				195
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	196	{ # Represents an external VPN gateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	197	#
				198	# External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway.
				199	#
				200	# To create a highly available VPN from Google Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, you must create a external VPN gateway resource with information about the other gateway.
				201	#
				202	# For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN. (== resource_for {$api_version}.externalVpnGateways ==)
				203	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				204	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				205	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				206	"interfaces": [ # List of interfaces for this external VPN gateway.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame^]	207	#
				208	# If your peer-side gateway is an on-premises gateway and non-AWS cloud providers? gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	209	{ # The interface for the external VPN gateway.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame^]	210	"id": 42, # The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway:
				211	# - SINGLE_IP_INTERNALLY_REDUNDANT - 0
				212	# - TWO_IPS_REDUNDANCY - 0, 1
				213	# - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	214	"ipAddress": "A String", # IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	215	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	216	],
				217	"kind": "compute#externalVpnGateway", # [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
				218	"labelFingerprint": "A String", # A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
				219	#
				220	# To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
				221	"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.
				222	"a_key": "A String",
				223	},
				224	"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.
				225	"redundancyType": "A String", # Indicates the user-supplied redundancy type of this external VPN gateway.
				226	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				227	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	228	</div>
				229
				230	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	231	<code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	232	<pre>Creates a ExternalVpnGateway in the specified project using the data included in the request.
				233
				234	Args:
				235	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	236	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	237	The object takes the form of:
				238
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	239	{ # Represents an external VPN gateway.
				240	#
				241	# External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway.
				242	#
				243	# To create a highly available VPN from Google Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, you must create a external VPN gateway resource with information about the other gateway.
				244	#
				245	# For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN. (== resource_for {$api_version}.externalVpnGateways ==)
				246	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				247	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				248	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				249	"interfaces": [ # List of interfaces for this external VPN gateway.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame^]	250	#
				251	# If your peer-side gateway is an on-premises gateway and non-AWS cloud providers? gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	252	{ # The interface for the external VPN gateway.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame^]	253	"id": 42, # The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway:
				254	# - SINGLE_IP_INTERNALLY_REDUNDANT - 0
				255	# - TWO_IPS_REDUNDANCY - 0, 1
				256	# - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	257	"ipAddress": "A String", # IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	258	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	259	],
				260	"kind": "compute#externalVpnGateway", # [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
				261	"labelFingerprint": "A String", # A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
				262	#
				263	# To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
				264	"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.
				265	"a_key": "A String",
				266	},
				267	"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.
				268	"redundancyType": "A String", # Indicates the user-supplied redundancy type of this external VPN gateway.
				269	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				270	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	271
				272	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.
				273
				274	For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
				275
				276	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				277
				278	Returns:
				279	An object of the form:
				280
				281	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	282	#
				283	# Google Compute Engine has three Operation resources:
				284	#
				285	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				286	#
				287	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				288	#
				289	# Operations can be global, regional or zonal.
				290	# - For global operations, use the `globalOperations` resource.
				291	# - For regional operations, use the `regionOperations` resource.
				292	# - For zonal operations, use the `zonalOperations` resource.
				293	#
				294	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				295	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				296	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				297	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				298	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				299	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				300	"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]	301	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	302	"code": "A String", # [Output Only] The error type identifier for this error.
				303	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				304	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	305	},
				306	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	307	},
				308	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				309	"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.
				310	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				311	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				312	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				313	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	314	"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]	315	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				316	"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.
				317	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				318	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				319	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				320	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				321	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				322	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				323	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				324	"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.
				325	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				326	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				327	{
				328	"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.
				329	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				330	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				331	{
				332	"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).
				333	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				334	},
				335	],
				336	"message": "A String", # [Output Only] A human-readable description of the warning code.
				337	},
				338	],
				339	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				340	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	341	</div>
				342
				343	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	344	<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	345	<pre>Retrieves the list of ExternalVpnGateway available to the specified project.
				346
				347	Args:
				348	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	349	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 `<`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	350
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	351	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	352
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	353	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	354
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	355	To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
				356	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`)
				357	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				358
				359	You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
				360
				361	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				362	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]	363	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	364
				365	Returns:
				366	An object of the form:
				367
				368	{ # Response to the list request, and contains a list of externalVpnGateways.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	369	"etag": "A String",
				370	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				371	"items": [ # A list of ExternalVpnGateway resources.
				372	{ # Represents an external VPN gateway.
				373	#
				374	# External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway.
				375	#
				376	# To create a highly available VPN from Google Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, you must create a external VPN gateway resource with information about the other gateway.
				377	#
				378	# For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN. (== resource_for {$api_version}.externalVpnGateways ==)
				379	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				380	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				381	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				382	"interfaces": [ # List of interfaces for this external VPN gateway.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame^]	383	#
				384	# If your peer-side gateway is an on-premises gateway and non-AWS cloud providers? gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	385	{ # The interface for the external VPN gateway.
yoshi-code-bot	73a0aa3	2021-05-25 00:30:03 -0700	[diff] [blame^]	386	"id": 42, # The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway:
				387	# - SINGLE_IP_INTERNALLY_REDUNDANT - 0
				388	# - TWO_IPS_REDUNDANCY - 0, 1
				389	# - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	390	"ipAddress": "A String", # IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	391	},
				392	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	393	"kind": "compute#externalVpnGateway", # [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
				394	"labelFingerprint": "A String", # A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
				395	#
				396	# To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
				397	"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.
				398	"a_key": "A String",
				399	},
				400	"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.
				401	"redundancyType": "A String", # Indicates the user-supplied redundancy type of this external VPN gateway.
				402	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	403	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	404	],
				405	"kind": "compute#externalVpnGatewayList", # [Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways.
				406	"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.
				407	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				408	"warning": { # [Output Only] Informational warning message.
				409	"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.
				410	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				411	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				412	{
				413	"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).
				414	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				415	},
				416	],
				417	"message": "A String", # [Output Only] A human-readable description of the warning code.
				418	},
				419	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	420	</div>
				421
				422	<div class="method">
				423	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				424	<pre>Retrieves the next page of results.
				425
				426	Args:
				427	previous_request: The request for the previous page. (required)
				428	previous_response: The response from the request for the previous page. (required)
				429
				430	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	431	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]	432	page. Returns None if there are no more items in the collection.
				433	</pre>
				434	</div>
				435
				436	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	437	<code class="details" id="setLabels">setLabels(project, resource, body=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	438	<pre>Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.
				439
				440	Args:
				441	project: string, Project ID for this request. (required)
				442	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]	443	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	444	The object takes the form of:
				445
				446	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	447	"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 when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint.
				448	"labels": { # A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
				449	"a_key": "A String",
				450	},
				451	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	452
				453
				454	Returns:
				455	An object of the form:
				456
				457	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	458	#
				459	# Google Compute Engine has three Operation resources:
				460	#
				461	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				462	#
				463	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				464	#
				465	# Operations can be global, regional or zonal.
				466	# - For global operations, use the `globalOperations` resource.
				467	# - For regional operations, use the `regionOperations` resource.
				468	# - For zonal operations, use the `zonalOperations` resource.
				469	#
				470	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				471	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				472	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				473	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				474	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				475	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				476	"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]	477	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	478	"code": "A String", # [Output Only] The error type identifier for this error.
				479	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				480	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	481	},
				482	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	483	},
				484	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				485	"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.
				486	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				487	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				488	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				489	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	490	"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]	491	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				492	"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.
				493	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				494	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				495	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				496	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				497	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				498	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				499	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				500	"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.
				501	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				502	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				503	{
				504	"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.
				505	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				506	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				507	{
				508	"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).
				509	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				510	},
				511	],
				512	"message": "A String", # [Output Only] A human-readable description of the warning code.
				513	},
				514	],
				515	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				516	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	517	</div>
				518
				519	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	520	<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	521	<pre>Returns permissions that a caller has on the specified resource.
				522
				523	Args:
				524	project: string, Project ID for this request. (required)
				525	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]	526	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	527	The object takes the form of:
				528
				529	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	530	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				531	"A String",
				532	],
				533	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	534
				535
				536	Returns:
				537	An object of the form:
				538
				539	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	540	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				541	"A String",
				542	],
				543	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	544	</div>
				545
				546	</body></html>