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

blob: d568acca56f198d5b31046d6b4267b683170326e [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.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">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	81	<code><a href="#delete">delete(project, externalVpnGateway, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	82	<p class="firstline">Deletes the specified externalVpnGateway.</p>
				83	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	84	<code><a href="#get">get(project, externalVpnGateway, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	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">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	87	<code><a href="#insert">insert(project, body=None, 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">Creates a ExternalVpnGateway in the specified project using the data included in the request.</p>
				89	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	90	<code><a href="#list">list(project, 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]	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">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	96	<code><a href="#setLabels">setLabels(project, resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -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">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	99	<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -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">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	108	<code class="details" id="delete">delete(project, externalVpnGateway, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	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)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	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. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				115	x__xgafv: string, V1 error format.
				116	Allowed values
				117	1 - v1 error format
				118	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	119
				120	Returns:
				121	An object of the form:
				122
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	123	{ # 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]	124	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				125	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				126	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				127	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				128	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				129	"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]	130	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	131	"code": "A String", # [Output Only] The error type identifier for this error.
				132	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				133	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	134	},
				135	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	136	},
				137	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				138	"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.
				139	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				140	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				141	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				142	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	143	"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]	144	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				145	"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.
				146	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				147	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				148	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				149	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				150	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				151	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				152	"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.
				153	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				154	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				155	{
				156	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	157	"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]	158	{
				159	"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).
				160	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				161	},
				162	],
				163	"message": "A String", # [Output Only] A human-readable description of the warning code.
				164	},
				165	],
				166	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				167	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	168	</div>
				169
				170	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	171	<code class="details" id="get">get(project, externalVpnGateway, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	172	<pre>Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.
				173
				174	Args:
				175	project: string, Project ID for this request. (required)
				176	externalVpnGateway: string, Name of the externalVpnGateway to return. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	177	x__xgafv: string, V1 error format.
				178	Allowed values
				179	1 - v1 error format
				180	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	181
				182	Returns:
				183	An object of the form:
				184
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	185	{ # Represents an external VPN gateway. 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. 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. For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	186	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				187	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				188	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	189	"interfaces": [ # A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	190	{ # The interface for the external VPN gateway.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	191	"id": 42, # The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: - SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	192	"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]	193	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	194	],
				195	"kind": "compute#externalVpnGateway", # [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	196	"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. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	197	"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.
				198	"a_key": "A String",
				199	},
				200	"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.
				201	"redundancyType": "A String", # Indicates the user-supplied redundancy type of this external VPN gateway.
				202	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				203	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	204	</div>
				205
				206	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	207	<code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	208	<pre>Creates a ExternalVpnGateway in the specified project using the data included in the request.
				209
				210	Args:
				211	project: string, Project ID for this request. (required)
				212	body: object, The request body.
				213	The object takes the form of:
				214
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	215	{ # Represents an external VPN gateway. 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. 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. For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	216	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				217	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				218	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	219	"interfaces": [ # A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	220	{ # The interface for the external VPN gateway.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	221	"id": 42, # The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: - SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	222	"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.
				223	},
				224	],
				225	"kind": "compute#externalVpnGateway", # [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	226	"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. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	227	"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.
				228	"a_key": "A String",
				229	},
				230	"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.
				231	"redundancyType": "A String", # Indicates the user-supplied redundancy type of this external VPN gateway.
				232	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				233	}
				234
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	235	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).
				236	x__xgafv: string, V1 error format.
				237	Allowed values
				238	1 - v1 error format
				239	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	240
				241	Returns:
				242	An object of the form:
				243
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	244	{ # 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]	245	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				246	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				247	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				248	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				249	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				250	"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]	251	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	252	"code": "A String", # [Output Only] The error type identifier for this error.
				253	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				254	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	255	},
				256	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	257	},
				258	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				259	"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.
				260	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				261	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				262	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				263	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	264	"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]	265	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				266	"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.
				267	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				268	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				269	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				270	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				271	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				272	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				273	"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.
				274	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				275	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				276	{
				277	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	278	"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]	279	{
				280	"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).
				281	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				282	},
				283	],
				284	"message": "A String", # [Output Only] A human-readable description of the warning code.
				285	},
				286	],
				287	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				288	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	289	</div>
				290
				291	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	292	<code class="details" id="list">list(project, 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]	293	<pre>Retrieves the list of ExternalVpnGateway available to the specified project.
				294
				295	Args:
				296	project: string, Project ID for this request. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	297	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]	298	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	299	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]	300	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]	301	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	302	x__xgafv: string, V1 error format.
				303	Allowed values
				304	1 - v1 error format
				305	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	306
				307	Returns:
				308	An object of the form:
				309
				310	{ # Response to the list request, and contains a list of externalVpnGateways.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	311	"etag": "A String",
				312	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				313	"items": [ # A list of ExternalVpnGateway resources.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	314	{ # Represents an external VPN gateway. 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. 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. For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	315	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				316	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				317	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	318	"interfaces": [ # A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	319	{ # The interface for the external VPN gateway.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	320	"id": 42, # The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: - SINGLE_IP_INTERNALLY_REDUNDANT - 0 - TWO_IPS_REDUNDANCY - 0, 1 - FOUR_IPS_REDUNDANCY - 0, 1, 2, 3
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	321	"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]	322	},
				323	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	324	"kind": "compute#externalVpnGateway", # [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	325	"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. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	326	"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.
				327	"a_key": "A String",
				328	},
				329	"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.
				330	"redundancyType": "A String", # Indicates the user-supplied redundancy type of this external VPN gateway.
				331	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	332	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	333	],
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	334	"kind": "compute#externalVpnGatewayList", # [Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	335	"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.
				336	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				337	"warning": { # [Output Only] Informational warning message.
				338	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	339	"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]	340	{
				341	"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).
				342	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				343	},
				344	],
				345	"message": "A String", # [Output Only] A human-readable description of the warning code.
				346	},
				347	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	348	</div>
				349
				350	<div class="method">
				351	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				352	<pre>Retrieves the next page of results.
				353
				354	Args:
				355	previous_request: The request for the previous page. (required)
				356	previous_response: The response from the request for the previous page. (required)
				357
				358	Returns:
				359	A request object that you can call 'execute()' on to request the next
				360	page. Returns None if there are no more items in the collection.
				361	</pre>
				362	</div>
				363
				364	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	365	<code class="details" id="setLabels">setLabels(project, resource, body=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	366	<pre>Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.
				367
				368	Args:
				369	project: string, Project ID for this request. (required)
				370	resource: string, Name or id of the resource for this request. (required)
				371	body: object, The request body.
				372	The object takes the form of:
				373
				374	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	375	"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.
				376	"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": "").
				377	"a_key": "A String",
				378	},
				379	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	380
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	381	x__xgafv: string, V1 error format.
				382	Allowed values
				383	1 - v1 error format
				384	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	385
				386	Returns:
				387	An object of the form:
				388
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	389	{ # 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]	390	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				391	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				392	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				393	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				394	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				395	"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]	396	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	397	"code": "A String", # [Output Only] The error type identifier for this error.
				398	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				399	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	400	},
				401	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	402	},
				403	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				404	"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.
				405	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				406	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				407	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				408	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	409	"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]	410	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				411	"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.
				412	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				413	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				414	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				415	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				416	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				417	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				418	"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.
				419	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				420	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				421	{
				422	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	423	"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]	424	{
				425	"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).
				426	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				427	},
				428	],
				429	"message": "A String", # [Output Only] A human-readable description of the warning code.
				430	},
				431	],
				432	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				433	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	434	</div>
				435
				436	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	437	<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	438	<pre>Returns permissions that a caller has on the specified resource.
				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)
				443	body: object, The request body.
				444	The object takes the form of:
				445
				446	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	447	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				448	"A String",
				449	],
				450	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	451
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	452	x__xgafv: string, V1 error format.
				453	Allowed values
				454	1 - v1 error format
				455	2 - v2 error format
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	456
				457	Returns:
				458	An object of the form:
				459
				460	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	461	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				462	"A String",
				463	],
				464	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	465	</div>
				466
				467	</body></html>