Blame - docs/dyn/compute_beta.sslPolicies.html - platform/external/python/google-api-python-client

blob: 23776ee87dd37255c0ff40b901dc8701ce1b33ba [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_beta.html">Compute Engine API</a> . <a href="compute_beta.sslPolicies.html">sslPolicies</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, sslPolicy, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	82	<p class="firstline">Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.</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, sslPolicy, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	85	<p class="firstline">Lists all of the ordered rules present in a single specified policy.</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	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() 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	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	91	<p class="firstline">Lists all the SSL policies that have been configured for the specified project.</p>
				92	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	93	<code><a href="#listAvailableFeatures">listAvailableFeatures(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	94	<p class="firstline">Lists all features that can be specified in the SSL policy when using custom profile.</p>
				95	<p class="toc_element">
				96	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				97	<p class="firstline">Retrieves the next page of results.</p>
				98	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	99	<code><a href="#patch">patch(project, sslPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	100	<p class="firstline">Patches the specified SSL policy with the data included in the request.</p>
				101	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	102	<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	103	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				104	<h3>Method Details</h3>
				105	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	106	<code class="details" id="close">close()</code>
				107	<pre>Close httplib2 connections.</pre>
				108	</div>
				109
				110	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	111	<code class="details" id="delete">delete(project, sslPolicy, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	112	<pre>Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.
				113
				114	Args:
				115	project: string, Project ID for this request. (required)
				116	sslPolicy: string, Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	117	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).
				118	x__xgafv: string, V1 error format.
				119	Allowed values
				120	1 - v1 error format
				121	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	122
				123	Returns:
				124	An object of the form:
				125
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	126	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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]	127	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				128	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				129	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				130	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				131	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				132	"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]	133	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	134	"code": "A String", # [Output Only] The error type identifier for this error.
				135	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				136	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	137	},
				138	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	139	},
				140	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				141	"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.
				142	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				143	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				144	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				145	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	146	"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]	147	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				148	"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.
				149	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				150	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				151	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				152	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				153	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				154	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				155	"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.
				156	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				157	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				158	{
				159	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	160	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	161	{
				162	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				163	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				164	},
				165	],
				166	"message": "A String", # [Output Only] A human-readable description of the warning code.
				167	},
				168	],
				169	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				170	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	171	</div>
				172
				173	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	174	<code class="details" id="get">get(project, sslPolicy, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	175	<pre>Lists all of the ordered rules present in a single specified policy.
				176
				177	Args:
				178	project: string, Project ID for this request. (required)
				179	sslPolicy: string, Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	180	x__xgafv: string, V1 error format.
				181	Allowed values
				182	1 - v1 error format
				183	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	184
				185	Returns:
				186	An object of the form:
				187
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	188	{ # Represents an SSL Policy resource. Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	189	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	190	"customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	191	"A String",
				192	],
				193	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				194	"enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy.
				195	"A String",
				196	],
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	197	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	198	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				199	"kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.
				200	"minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.
				201	"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				202	"profile": "A String", # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.
				203	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				204	"warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.
				205	{
				206	"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]	207	"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]	208	{
				209	"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).
				210	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				211	},
				212	],
				213	"message": "A String", # [Output Only] A human-readable description of the warning code.
				214	},
				215	],
				216	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	217	</div>
				218
				219	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	220	<code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	221	<pre>Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.
				222
				223	Args:
				224	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	225	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	226	The object takes the form of:
				227
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	228	{ # Represents an SSL Policy resource. Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	229	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	230	"customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	231	"A String",
				232	],
				233	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				234	"enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy.
				235	"A String",
				236	],
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	237	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	238	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				239	"kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.
				240	"minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.
				241	"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				242	"profile": "A String", # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.
				243	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				244	"warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.
				245	{
				246	"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]	247	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	248	{
				249	"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).
				250	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				251	},
				252	],
				253	"message": "A String", # [Output Only] A human-readable description of the warning code.
				254	},
				255	],
				256	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	257
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	258	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).
				259	x__xgafv: string, V1 error format.
				260	Allowed values
				261	1 - v1 error format
				262	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	263
				264	Returns:
				265	An object of the form:
				266
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	267	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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]	268	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				269	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				270	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				271	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				272	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				273	"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]	274	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	275	"code": "A String", # [Output Only] The error type identifier for this error.
				276	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				277	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	278	},
				279	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	280	},
				281	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				282	"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.
				283	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				284	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				285	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				286	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	287	"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]	288	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				289	"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.
				290	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				291	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				292	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				293	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				294	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				295	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				296	"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.
				297	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				298	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				299	{
				300	"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]	301	"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]	302	{
				303	"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).
				304	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				305	},
				306	],
				307	"message": "A String", # [Output Only] A human-readable description of the warning code.
				308	},
				309	],
				310	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				311	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	312	</div>
				313
				314	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	315	<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	316	<pre>Lists all the SSL policies that have been configured for the specified project.
				317
				318	Args:
				319	project: string, Project ID for this request. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	320	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]	321	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]	322	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]	323	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]	324	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]	325	x__xgafv: string, V1 error format.
				326	Allowed values
				327	1 - v1 error format
				328	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	329
				330	Returns:
				331	An object of the form:
				332
				333	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	334	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				335	"items": [ # A list of SslPolicy resources.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	336	{ # Represents an SSL Policy resource. Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	337	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	338	"customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	339	"A String",
				340	],
				341	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				342	"enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy.
				343	"A String",
				344	],
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	345	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	346	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				347	"kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.
				348	"minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.
				349	"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				350	"profile": "A String", # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.
				351	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				352	"warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	353	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	354	"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]	355	"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]	356	{
				357	"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).
				358	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				359	},
				360	],
				361	"message": "A String", # [Output Only] A human-readable description of the warning code.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	362	},
				363	],
				364	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	365	],
				366	"kind": "compute#sslPoliciesList", # [Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies.
				367	"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.
				368	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				369	"warning": { # [Output Only] Informational warning message.
				370	"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]	371	"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]	372	{
				373	"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).
				374	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				375	},
				376	],
				377	"message": "A String", # [Output Only] A human-readable description of the warning code.
				378	},
				379	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	380	</div>
				381
				382	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	383	<code class="details" id="listAvailableFeatures">listAvailableFeatures(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	384	<pre>Lists all features that can be specified in the SSL policy when using custom profile.
				385
				386	Args:
				387	project: string, Project ID for this request. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	388	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]	389	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]	390	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]	391	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]	392	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]	393	x__xgafv: string, V1 error format.
				394	Allowed values
				395	1 - v1 error format
				396	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	397
				398	Returns:
				399	An object of the form:
				400
				401	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	402	"features": [
				403	"A String",
				404	],
				405	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	406	</div>
				407
				408	<div class="method">
				409	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				410	<pre>Retrieves the next page of results.
				411
				412	Args:
				413	previous_request: The request for the previous page. (required)
				414	previous_response: The response from the request for the previous page. (required)
				415
				416	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	417	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]	418	page. Returns None if there are no more items in the collection.
				419	</pre>
				420	</div>
				421
				422	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	423	<code class="details" id="patch">patch(project, sslPolicy, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	424	<pre>Patches the specified SSL policy with the data included in the request.
				425
				426	Args:
				427	project: string, Project ID for this request. (required)
				428	sslPolicy: string, Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	429	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	430	The object takes the form of:
				431
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	432	{ # Represents an SSL Policy resource. Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	433	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	434	"customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	435	"A String",
				436	],
				437	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				438	"enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy.
				439	"A String",
				440	],
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	441	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	442	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				443	"kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.
				444	"minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.
				445	"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				446	"profile": "A String", # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.
				447	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				448	"warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.
				449	{
				450	"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]	451	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	452	{
				453	"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).
				454	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				455	},
				456	],
				457	"message": "A String", # [Output Only] A human-readable description of the warning code.
				458	},
				459	],
				460	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	461
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	462	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).
				463	x__xgafv: string, V1 error format.
				464	Allowed values
				465	1 - v1 error format
				466	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	467
				468	Returns:
				469	An object of the form:
				470
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	471	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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]	472	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				473	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				474	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				475	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				476	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				477	"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]	478	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	479	"code": "A String", # [Output Only] The error type identifier for this error.
				480	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				481	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	482	},
				483	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	484	},
				485	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				486	"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.
				487	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				488	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				489	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				490	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	491	"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]	492	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				493	"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.
				494	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				495	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				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.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	505	"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]	506	{
				507	"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).
				508	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				509	},
				510	],
				511	"message": "A String", # [Output Only] A human-readable description of the warning code.
				512	},
				513	],
				514	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				515	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	516	</div>
				517
				518	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	519	<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	520	<pre>Returns permissions that a caller has on the specified resource.
				521
				522	Args:
				523	project: string, Project ID for this request. (required)
				524	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]	525	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	526	The object takes the form of:
				527
				528	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	529	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				530	"A String",
				531	],
				532	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	533
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	534	x__xgafv: string, V1 error format.
				535	Allowed values
				536	1 - v1 error format
				537	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	538
				539	Returns:
				540	An object of the form:
				541
				542	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	543	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				544	"A String",
				545	],
				546	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	547	</div>
				548
				549	</body></html>