Blame - docs/dyn/dataproc_v1beta2.projects.regions.autoscalingPolicies.html - platform/external/python/google-api-python-client

blob: d7e1b2542ecd6f049c79b809cb75738a59a1b36e [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="dataproc_v1beta2.html">Cloud Dataproc API</a> . <a href="dataproc_v1beta2.projects.html">projects</a> . <a href="dataproc_v1beta2.projects.regions.html">regions</a> . <a href="dataproc_v1beta2.projects.regions.autoscalingPolicies.html">autoscalingPolicies</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	79	<p class="firstline">Creates new autoscaling policy.</p>
				80	<p class="toc_element">
				81	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.</p>
				83	<p class="toc_element">
				84	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Retrieves autoscaling policy.</p>
				86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
				89	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	90	<code><a href="#list">list(parent, pageToken=None, pageSize=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 autoscaling policies in the project.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#setIamPolicy">setIamPolicy(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 access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	98	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	100	<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
				101	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	102	<code><a href="#update">update(name, 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">Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements.</p>
				104	<h3>Method Details</h3>
				105	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	106	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	107	<pre>Creates new autoscaling policy.
				108
				109	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	110	parent: string, Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	111	For projects.regions.autoscalingPolicies.create, the resource name has the following format: projects/{project_id}/regions/{region}
				112	For projects.locations.autoscalingPolicies.create, the resource name has the following format: projects/{project_id}/locations/{location} (required)
				113	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	114	The object takes the form of:
				115
				116	{ # Describes an autoscaling policy for Dataproc cluster autoscaler.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	117	"workerConfig": { # Configuration for the size bounds of an instance group, including its proportional size to other groups. # Required. Describes how the autoscaler will operate for primary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	118	"maxInstances": 42, # Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0.
				119	"minInstances": 42, # Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	120	"weight": 42, # Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	121	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	122	"name": "A String", # Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	123	# For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}
				124	# For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	125	"secondaryWorkerConfig": { # Configuration for the size bounds of an instance group, including its proportional size to other groups. # Optional. Describes how the autoscaler will operate for secondary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	126	"maxInstances": 42, # Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0.
				127	"minInstances": 42, # Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	128	"weight": 42, # Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	129	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	130	"basicAlgorithm": { # Basic algorithm for autoscaling.
				131	"yarnConfig": { # Basic autoscaling configurations for YARN. # Required. YARN autoscaling configuration.
				132	"scaleUpMinWorkerFraction": 3.14, # Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.
				133	"gracefulDecommissionTimeout": "A String", # Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.Bounds: 0s, 1d.
				134	"scaleUpFactor": 3.14, # Required. Fraction of average pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling).Bounds: 0.0, 1.0.
				135	"scaleDownFactor": 3.14, # Required. Fraction of average pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job.Bounds: 0.0, 1.0.
				136	"scaleDownMinWorkerFraction": 3.14, # Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.
				137	},
				138	"cooldownPeriod": "A String", # Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed.Bounds: 2m, 1d. Default: 2m.
				139	},
				140	"id": "A String", # Required. The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	141	}
				142
				143	x__xgafv: string, V1 error format.
				144	Allowed values
				145	1 - v1 error format
				146	2 - v2 error format
				147
				148	Returns:
				149	An object of the form:
				150
				151	{ # Describes an autoscaling policy for Dataproc cluster autoscaler.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	152	"workerConfig": { # Configuration for the size bounds of an instance group, including its proportional size to other groups. # Required. Describes how the autoscaler will operate for primary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	153	"maxInstances": 42, # Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0.
				154	"minInstances": 42, # Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	155	"weight": 42, # Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	156	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	157	"name": "A String", # Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	158	# For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}
				159	# For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	160	"secondaryWorkerConfig": { # Configuration for the size bounds of an instance group, including its proportional size to other groups. # Optional. Describes how the autoscaler will operate for secondary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	161	"maxInstances": 42, # Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0.
				162	"minInstances": 42, # Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	163	"weight": 42, # Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	164	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	165	"basicAlgorithm": { # Basic algorithm for autoscaling.
				166	"yarnConfig": { # Basic autoscaling configurations for YARN. # Required. YARN autoscaling configuration.
				167	"scaleUpMinWorkerFraction": 3.14, # Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.
				168	"gracefulDecommissionTimeout": "A String", # Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.Bounds: 0s, 1d.
				169	"scaleUpFactor": 3.14, # Required. Fraction of average pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling).Bounds: 0.0, 1.0.
				170	"scaleDownFactor": 3.14, # Required. Fraction of average pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job.Bounds: 0.0, 1.0.
				171	"scaleDownMinWorkerFraction": 3.14, # Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.
				172	},
				173	"cooldownPeriod": "A String", # Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed.Bounds: 2m, 1d. Default: 2m.
				174	},
				175	"id": "A String", # Required. The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	176	}</pre>
				177	</div>
				178
				179	<div class="method">
				180	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				181	<pre>Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.
				182
				183	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	184	name: string, Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	185	For projects.regions.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}
				186	For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	187	x__xgafv: string, V1 error format.
				188	Allowed values
				189	1 - v1 error format
				190	2 - v2 error format
				191
				192	Returns:
				193	An object of the form:
				194
				195	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
				196	# service Foo {
				197	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				198	# }
				199	# The JSON representation for Empty is empty JSON object {}.
				200	}</pre>
				201	</div>
				202
				203	<div class="method">
				204	<code class="details" id="get">get(name, x__xgafv=None)</code>
				205	<pre>Retrieves autoscaling policy.
				206
				207	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	208	name: string, Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	209	For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}
				210	For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	211	x__xgafv: string, V1 error format.
				212	Allowed values
				213	1 - v1 error format
				214	2 - v2 error format
				215
				216	Returns:
				217	An object of the form:
				218
				219	{ # Describes an autoscaling policy for Dataproc cluster autoscaler.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	220	"workerConfig": { # Configuration for the size bounds of an instance group, including its proportional size to other groups. # Required. Describes how the autoscaler will operate for primary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	221	"maxInstances": 42, # Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0.
				222	"minInstances": 42, # Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	223	"weight": 42, # Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	224	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	225	"name": "A String", # Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	226	# For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}
				227	# For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	228	"secondaryWorkerConfig": { # Configuration for the size bounds of an instance group, including its proportional size to other groups. # Optional. Describes how the autoscaler will operate for secondary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	229	"maxInstances": 42, # Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0.
				230	"minInstances": 42, # Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	231	"weight": 42, # Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	232	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	233	"basicAlgorithm": { # Basic algorithm for autoscaling.
				234	"yarnConfig": { # Basic autoscaling configurations for YARN. # Required. YARN autoscaling configuration.
				235	"scaleUpMinWorkerFraction": 3.14, # Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.
				236	"gracefulDecommissionTimeout": "A String", # Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.Bounds: 0s, 1d.
				237	"scaleUpFactor": 3.14, # Required. Fraction of average pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling).Bounds: 0.0, 1.0.
				238	"scaleDownFactor": 3.14, # Required. Fraction of average pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job.Bounds: 0.0, 1.0.
				239	"scaleDownMinWorkerFraction": 3.14, # Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.
				240	},
				241	"cooldownPeriod": "A String", # Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed.Bounds: 2m, 1d. Default: 2m.
				242	},
				243	"id": "A String", # Required. The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	244	}</pre>
				245	</div>
				246
				247	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	248	<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	249	<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
				250
				251	Args:
				252	resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	253	options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	254	x__xgafv: string, V1 error format.
				255	Allowed values
				256	1 - v1 error format
				257	2 - v2 error format
				258
				259	Returns:
				260	An object of the form:
				261
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	262	{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example:
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	263	# {
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	264	# "bindings": [
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	265	# {
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	266	# "role": "roles/resourcemanager.organizationAdmin",
				267	# "members": [
				268	# "user:mike@example.com",
				269	# "group:admins@example.com",
				270	# "domain:google.com",
				271	# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	272	# ]
				273	# },
				274	# {
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	275	# "role": "roles/resourcemanager.organizationViewer",
				276	# "members": [
				277	# "user:eve@example.com"
				278	# ],
				279	# "condition": {
				280	# "title": "expirable access",
				281	# "description": "Does not grant access after Sep 2020",
				282	# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	283	# }
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	284	# }
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	285	# ],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	286	# "etag": "BwWWja0YfJA=",
				287	# "version": 3
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	288	# }
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	289	# YAML example:
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	290	# bindings:
				291	# - members:
				292	# - user:mike@example.com
				293	# - group:admins@example.com
				294	# - domain:google.com
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	295	# - serviceAccount:my-project-id@appspot.gserviceaccount.com
				296	# role: roles/resourcemanager.organizationAdmin
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	297	# - members:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	298	# - user:eve@example.com
				299	# role: roles/resourcemanager.organizationViewer
				300	# condition:
				301	# title: expirable access
				302	# description: Does not grant access after Sep 2020
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	303	# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	304	# - etag: BwWWja0YfJA=
				305	# - version: 3
				306	# For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	307	"bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	308	{ # Associates members with a role.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	309	"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
				310	# title: "Summary size limit"
				311	# description: "Determines if a summary is less than 100 chars"
				312	# expression: "document.summary.size() < 100"
				313	# Example (Equality):
				314	# title: "Requestor is owner"
				315	# description: "Determines if requestor is the document owner"
				316	# expression: "document.owner == request.auth.claims.email"
				317	# Example (Logic):
				318	# title: "Public documents"
				319	# description: "Determine whether the document should be publicly visible"
				320	# expression: "document.type != 'private' && document.type != 'internal'"
				321	# Example (Data Manipulation):
				322	# title: "Notification string"
				323	# description: "Create a notification string with a timestamp."
				324	# expression: "'New message received at ' + string(document.create_time)"
				325	# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	326	"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
				327	"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	328	"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
				329	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	330	},
				331	"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	332	# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
				333	# allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	334	# user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	335	# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
				336	# group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	337	# deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
				338	# deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
				339	# deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	340	# domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	341	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	342	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	343	"role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	344	},
				345	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	346	"etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
				347	"version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
				348	# Getting a policy that includes a conditional role binding
				349	# Adding a conditional role binding to a policy
				350	# Changing a conditional role binding in a policy
				351	# Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	352	}</pre>
				353	</div>
				354
				355	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	356	<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	357	<pre>Lists autoscaling policies in the project.
				358
				359	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	360	parent: string, Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	361	For projects.regions.autoscalingPolicies.list, the resource name of the region has the following format: projects/{project_id}/regions/{region}
				362	For projects.locations.autoscalingPolicies.list, the resource name of the location has the following format: projects/{project_id}/locations/{location} (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	363	pageToken: string, Optional. The page token, returned by a previous call, to request the next page of results.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	364	pageSize: integer, Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	365	x__xgafv: string, V1 error format.
				366	Allowed values
				367	1 - v1 error format
				368	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	369
				370	Returns:
				371	An object of the form:
				372
				373	{ # A response to a request to list autoscaling policies in a project.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	374	"nextPageToken": "A String", # Output only. This token is included in the response if there are more results to fetch.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	375	"policies": [ # Output only. Autoscaling policies list.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	376	{ # Describes an autoscaling policy for Dataproc cluster autoscaler.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	377	"workerConfig": { # Configuration for the size bounds of an instance group, including its proportional size to other groups. # Required. Describes how the autoscaler will operate for primary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	378	"maxInstances": 42, # Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0.
				379	"minInstances": 42, # Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	380	"weight": 42, # Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	381	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	382	"name": "A String", # Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	383	# For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}
				384	# For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	385	"secondaryWorkerConfig": { # Configuration for the size bounds of an instance group, including its proportional size to other groups. # Optional. Describes how the autoscaler will operate for secondary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	386	"maxInstances": 42, # Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0.
				387	"minInstances": 42, # Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	388	"weight": 42, # Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	389	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	390	"basicAlgorithm": { # Basic algorithm for autoscaling.
				391	"yarnConfig": { # Basic autoscaling configurations for YARN. # Required. YARN autoscaling configuration.
				392	"scaleUpMinWorkerFraction": 3.14, # Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.
				393	"gracefulDecommissionTimeout": "A String", # Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.Bounds: 0s, 1d.
				394	"scaleUpFactor": 3.14, # Required. Fraction of average pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling).Bounds: 0.0, 1.0.
				395	"scaleDownFactor": 3.14, # Required. Fraction of average pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job.Bounds: 0.0, 1.0.
				396	"scaleDownMinWorkerFraction": 3.14, # Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.
				397	},
				398	"cooldownPeriod": "A String", # Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed.Bounds: 2m, 1d. Default: 2m.
				399	},
				400	"id": "A String", # Required. The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	401	},
				402	],
				403	}</pre>
				404	</div>
				405
				406	<div class="method">
				407	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				408	<pre>Retrieves the next page of results.
				409
				410	Args:
				411	previous_request: The request for the previous page. (required)
				412	previous_response: The response from the request for the previous page. (required)
				413
				414	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	415	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]	416	page. Returns None if there are no more items in the collection.
				417	</pre>
				418	</div>
				419
				420	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	421	<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	422	<pre>Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	423
				424	Args:
				425	resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	426	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	427	The object takes the form of:
				428
				429	{ # Request message for SetIamPolicy method.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	430	"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	431	# {
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	432	# "bindings": [
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	433	# {
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	434	# "role": "roles/resourcemanager.organizationAdmin",
				435	# "members": [
				436	# "user:mike@example.com",
				437	# "group:admins@example.com",
				438	# "domain:google.com",
				439	# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	440	# ]
				441	# },
				442	# {
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	443	# "role": "roles/resourcemanager.organizationViewer",
				444	# "members": [
				445	# "user:eve@example.com"
				446	# ],
				447	# "condition": {
				448	# "title": "expirable access",
				449	# "description": "Does not grant access after Sep 2020",
				450	# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	451	# }
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	452	# }
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	453	# ],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	454	# "etag": "BwWWja0YfJA=",
				455	# "version": 3
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	456	# }
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	457	# YAML example:
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	458	# bindings:
				459	# - members:
				460	# - user:mike@example.com
				461	# - group:admins@example.com
				462	# - domain:google.com
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	463	# - serviceAccount:my-project-id@appspot.gserviceaccount.com
				464	# role: roles/resourcemanager.organizationAdmin
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	465	# - members:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	466	# - user:eve@example.com
				467	# role: roles/resourcemanager.organizationViewer
				468	# condition:
				469	# title: expirable access
				470	# description: Does not grant access after Sep 2020
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	471	# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	472	# - etag: BwWWja0YfJA=
				473	# - version: 3
				474	# For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	475	"bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	476	{ # Associates members with a role.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	477	"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
				478	# title: "Summary size limit"
				479	# description: "Determines if a summary is less than 100 chars"
				480	# expression: "document.summary.size() < 100"
				481	# Example (Equality):
				482	# title: "Requestor is owner"
				483	# description: "Determines if requestor is the document owner"
				484	# expression: "document.owner == request.auth.claims.email"
				485	# Example (Logic):
				486	# title: "Public documents"
				487	# description: "Determine whether the document should be publicly visible"
				488	# expression: "document.type != 'private' && document.type != 'internal'"
				489	# Example (Data Manipulation):
				490	# title: "Notification string"
				491	# description: "Create a notification string with a timestamp."
				492	# expression: "'New message received at ' + string(document.create_time)"
				493	# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	494	"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
				495	"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	496	"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
				497	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	498	},
				499	"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	500	# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
				501	# allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	502	# user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	503	# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
				504	# group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	505	# deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
				506	# deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
				507	# deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	508	# domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	509	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	510	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	511	"role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	512	},
				513	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	514	"etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
				515	"version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
				516	# Getting a policy that includes a conditional role binding
				517	# Adding a conditional role binding to a policy
				518	# Changing a conditional role binding in a policy
				519	# Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	520	},
				521	}
				522
				523	x__xgafv: string, V1 error format.
				524	Allowed values
				525	1 - v1 error format
				526	2 - v2 error format
				527
				528	Returns:
				529	An object of the form:
				530
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	531	{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example:
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	532	# {
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	533	# "bindings": [
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	534	# {
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	535	# "role": "roles/resourcemanager.organizationAdmin",
				536	# "members": [
				537	# "user:mike@example.com",
				538	# "group:admins@example.com",
				539	# "domain:google.com",
				540	# "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	541	# ]
				542	# },
				543	# {
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	544	# "role": "roles/resourcemanager.organizationViewer",
				545	# "members": [
				546	# "user:eve@example.com"
				547	# ],
				548	# "condition": {
				549	# "title": "expirable access",
				550	# "description": "Does not grant access after Sep 2020",
				551	# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	552	# }
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	553	# }
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	554	# ],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	555	# "etag": "BwWWja0YfJA=",
				556	# "version": 3
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	557	# }
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	558	# YAML example:
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	559	# bindings:
				560	# - members:
				561	# - user:mike@example.com
				562	# - group:admins@example.com
				563	# - domain:google.com
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	564	# - serviceAccount:my-project-id@appspot.gserviceaccount.com
				565	# role: roles/resourcemanager.organizationAdmin
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	566	# - members:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	567	# - user:eve@example.com
				568	# role: roles/resourcemanager.organizationViewer
				569	# condition:
				570	# title: expirable access
				571	# description: Does not grant access after Sep 2020
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	572	# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	573	# - etag: BwWWja0YfJA=
				574	# - version: 3
				575	# For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	576	"bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	577	{ # Associates members with a role.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	578	"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
				579	# title: "Summary size limit"
				580	# description: "Determines if a summary is less than 100 chars"
				581	# expression: "document.summary.size() < 100"
				582	# Example (Equality):
				583	# title: "Requestor is owner"
				584	# description: "Determines if requestor is the document owner"
				585	# expression: "document.owner == request.auth.claims.email"
				586	# Example (Logic):
				587	# title: "Public documents"
				588	# description: "Determine whether the document should be publicly visible"
				589	# expression: "document.type != 'private' && document.type != 'internal'"
				590	# Example (Data Manipulation):
				591	# title: "Notification string"
				592	# description: "Create a notification string with a timestamp."
				593	# expression: "'New message received at ' + string(document.create_time)"
				594	# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	595	"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
				596	"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	597	"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
				598	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	599	},
				600	"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	601	# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
				602	# allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	603	# user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	604	# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
				605	# group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	606	# deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
				607	# deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
				608	# deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	609	# domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	610	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	611	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	612	"role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	613	},
				614	],
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	615	"etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
				616	"version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
				617	# Getting a policy that includes a conditional role binding
				618	# Adding a conditional role binding to a policy
				619	# Changing a conditional role binding in a policy
				620	# Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	621	}</pre>
				622	</div>
				623
				624	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	625	<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	626	<pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	627
				628	Args:
				629	resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	630	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	631	The object takes the form of:
				632
				633	{ # Request message for TestIamPermissions method.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	634	"permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
				635	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	636	],
				637	}
				638
				639	x__xgafv: string, V1 error format.
				640	Allowed values
				641	1 - v1 error format
				642	2 - v2 error format
				643
				644	Returns:
				645	An object of the form:
				646
				647	{ # Response message for TestIamPermissions method.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	648	"permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
				649	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	650	],
				651	}</pre>
				652	</div>
				653
				654	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	655	<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	656	<pre>Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements.
				657
				658	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	659	name: string, Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	660	For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}
				661	For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} (required)
				662	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	663	The object takes the form of:
				664
				665	{ # Describes an autoscaling policy for Dataproc cluster autoscaler.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	666	"workerConfig": { # Configuration for the size bounds of an instance group, including its proportional size to other groups. # Required. Describes how the autoscaler will operate for primary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	667	"maxInstances": 42, # Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0.
				668	"minInstances": 42, # Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	669	"weight": 42, # Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	670	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	671	"name": "A String", # Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	672	# For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}
				673	# For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	674	"secondaryWorkerConfig": { # Configuration for the size bounds of an instance group, including its proportional size to other groups. # Optional. Describes how the autoscaler will operate for secondary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	675	"maxInstances": 42, # Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0.
				676	"minInstances": 42, # Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	677	"weight": 42, # Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	678	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	679	"basicAlgorithm": { # Basic algorithm for autoscaling.
				680	"yarnConfig": { # Basic autoscaling configurations for YARN. # Required. YARN autoscaling configuration.
				681	"scaleUpMinWorkerFraction": 3.14, # Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.
				682	"gracefulDecommissionTimeout": "A String", # Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.Bounds: 0s, 1d.
				683	"scaleUpFactor": 3.14, # Required. Fraction of average pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling).Bounds: 0.0, 1.0.
				684	"scaleDownFactor": 3.14, # Required. Fraction of average pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job.Bounds: 0.0, 1.0.
				685	"scaleDownMinWorkerFraction": 3.14, # Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.
				686	},
				687	"cooldownPeriod": "A String", # Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed.Bounds: 2m, 1d. Default: 2m.
				688	},
				689	"id": "A String", # Required. The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	690	}
				691
				692	x__xgafv: string, V1 error format.
				693	Allowed values
				694	1 - v1 error format
				695	2 - v2 error format
				696
				697	Returns:
				698	An object of the form:
				699
				700	{ # Describes an autoscaling policy for Dataproc cluster autoscaler.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	701	"workerConfig": { # Configuration for the size bounds of an instance group, including its proportional size to other groups. # Required. Describes how the autoscaler will operate for primary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	702	"maxInstances": 42, # Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0.
				703	"minInstances": 42, # Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	704	"weight": 42, # Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	705	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	706	"name": "A String", # Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	707	# For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}
				708	# For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	709	"secondaryWorkerConfig": { # Configuration for the size bounds of an instance group, including its proportional size to other groups. # Optional. Describes how the autoscaler will operate for secondary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	710	"maxInstances": 42, # Optional. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0.
				711	"minInstances": 42, # Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	712	"weight": 42, # Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	713	},
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	714	"basicAlgorithm": { # Basic algorithm for autoscaling.
				715	"yarnConfig": { # Basic autoscaling configurations for YARN. # Required. YARN autoscaling configuration.
				716	"scaleUpMinWorkerFraction": 3.14, # Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.
				717	"gracefulDecommissionTimeout": "A String", # Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.Bounds: 0s, 1d.
				718	"scaleUpFactor": 3.14, # Required. Fraction of average pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling).Bounds: 0.0, 1.0.
				719	"scaleDownFactor": 3.14, # Required. Fraction of average pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job.Bounds: 0.0, 1.0.
				720	"scaleDownMinWorkerFraction": 3.14, # Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.
				721	},
				722	"cooldownPeriod": "A String", # Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed.Bounds: 2m, 1d. Default: 2m.
				723	},
				724	"id": "A String", # Required. The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	725	}</pre>
				726	</div>
				727
				728	</body></html>