Blame - docs/dyn/gameservices_v1beta.projects.locations.realms.html - platform/external/python/google-api-python-client

blob: e7e5d76c24489c577e734ea997c8c2f0879ad461 [file] [log] [blame]

Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="gameservices_v1beta.html">Game Services API</a> . <a href="gameservices_v1beta.projects.html">projects</a> . <a href="gameservices_v1beta.projects.locations.html">locations</a> . <a href="gameservices_v1beta.projects.locations.realms.html">realms</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="gameservices_v1beta.projects.locations.realms.gameServerClusters.html">gameServerClusters()</a></code>
				79	</p>
				80	<p class="firstline">Returns the gameServerClusters Resource.</p>
				81
				82	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	83	<code><a href="#close">close()</a></code></p>
				84	<p class="firstline">Close httplib2 connections.</p>
				85	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	86	<code><a href="#create">create(parent, body=None, realmId=None, x__xgafv=None)</a></code></p>
				87	<p class="firstline">Creates a new realm in a given project and location.</p>
				88	<p class="toc_element">
				89	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				90	<p class="firstline">Deletes a single realm.</p>
				91	<p class="toc_element">
				92	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				93	<p class="firstline">Gets details of a single realm.</p>
				94	<p class="toc_element">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	95	<code><a href="#list">list(parent, pageSize=None, orderBy=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	96	<p class="firstline">Lists realms in a given project and location.</p>
				97	<p class="toc_element">
				98	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				99	<p class="firstline">Retrieves the next page of results.</p>
				100	<p class="toc_element">
				101	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				102	<p class="firstline">Patches a single realm.</p>
				103	<p class="toc_element">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	104	<code><a href="#previewUpdate">previewUpdate(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	105	<p class="firstline">Previews patches to a single realm.</p>
				106	<h3>Method Details</h3>
				107	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	108	<code class="details" id="close">close()</code>
				109	<pre>Close httplib2 connections.</pre>
				110	</div>
				111
				112	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	113	<code class="details" id="create">create(parent, body=None, realmId=None, x__xgafv=None)</code>
				114	<pre>Creates a new realm in a given project and location.
				115
				116	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	117	parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	118	body: object, The request body.
				119	The object takes the form of:
				120
				121	{ # A realm resource.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	122	"name": "A String", # The resource name of the realm, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`.
				123	"description": "A String", # Human readable description of the realm.
				124	"etag": "A String", # ETag of the resource.
				125	"createTime": "A String", # Output only. The creation time.
				126	"timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones.
				127	"updateTime": "A String", # Output only. The last-modified time.
				128	"labels": { # The labels associated with this realm. Each label is a key-value pair.
				129	"a_key": "A String",
				130	},
				131	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	132
				133	realmId: string, Required. The ID of the realm resource to be created.
				134	x__xgafv: string, V1 error format.
				135	Allowed values
				136	1 - v1 error format
				137	2 - v2 error format
				138
				139	Returns:
				140	An object of the form:
				141
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	142	{ # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	143	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	144	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	145	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	146	{
				147	"a_key": "", # Properties of the object. Contains field @type with type URL.
				148	},
				149	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	150	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	151	},
				152	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				153	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				154	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				155	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	156	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	157	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				158	"a_key": "", # Properties of the object. Contains field @type with type URL.
				159	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	160	}</pre>
				161	</div>
				162
				163	<div class="method">
				164	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				165	<pre>Deletes a single realm.
				166
				167	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	168	name: string, Required. The name of the realm to delete, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	169	x__xgafv: string, V1 error format.
				170	Allowed values
				171	1 - v1 error format
				172	2 - v2 error format
				173
				174	Returns:
				175	An object of the form:
				176
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	177	{ # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	178	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	179	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	180	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	181	{
				182	"a_key": "", # Properties of the object. Contains field @type with type URL.
				183	},
				184	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	185	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	186	},
				187	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				188	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				189	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				190	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	191	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	192	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				193	"a_key": "", # Properties of the object. Contains field @type with type URL.
				194	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	195	}</pre>
				196	</div>
				197
				198	<div class="method">
				199	<code class="details" id="get">get(name, x__xgafv=None)</code>
				200	<pre>Gets details of a single realm.
				201
				202	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	203	name: string, Required. The name of the realm to retrieve, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	204	x__xgafv: string, V1 error format.
				205	Allowed values
				206	1 - v1 error format
				207	2 - v2 error format
				208
				209	Returns:
				210	An object of the form:
				211
				212	{ # A realm resource.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	213	"name": "A String", # The resource name of the realm, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`.
				214	"description": "A String", # Human readable description of the realm.
				215	"etag": "A String", # ETag of the resource.
				216	"createTime": "A String", # Output only. The creation time.
				217	"timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones.
				218	"updateTime": "A String", # Output only. The last-modified time.
				219	"labels": { # The labels associated with this realm. Each label is a key-value pair.
				220	"a_key": "A String",
				221	},
				222	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	223	</div>
				224
				225	<div class="method">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	226	<code class="details" id="list">list(parent, pageSize=None, orderBy=None, filter=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	227	<pre>Lists realms in a given project and location.
				228
				229	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	230	parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`. (required)
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	231	pageSize: integer, Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more realms left to be queried.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	232	orderBy: string, Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	233	filter: string, Optional. The filter to apply to list results.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	234	pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	235	x__xgafv: string, V1 error format.
				236	Allowed values
				237	1 - v1 error format
				238	2 - v2 error format
				239
				240	Returns:
				241	An object of the form:
				242
				243	{ # Response message for RealmsService.ListRealms.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	244	"realms": [ # The list of realms.
				245	{ # A realm resource.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	246	"name": "A String", # The resource name of the realm, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`.
				247	"description": "A String", # Human readable description of the realm.
				248	"etag": "A String", # ETag of the resource.
				249	"createTime": "A String", # Output only. The creation time.
				250	"timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones.
				251	"updateTime": "A String", # Output only. The last-modified time.
				252	"labels": { # The labels associated with this realm. Each label is a key-value pair.
				253	"a_key": "A String",
				254	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	255	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	256	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	257	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	258	"unreachable": [ # List of locations that could not be reached.
				259	"A String",
				260	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	261	}</pre>
				262	</div>
				263
				264	<div class="method">
				265	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				266	<pre>Retrieves the next page of results.
				267
				268	Args:
				269	previous_request: The request for the previous page. (required)
				270	previous_response: The response from the request for the previous page. (required)
				271
				272	Returns:
				273	A request object that you can call 'execute()' on to request the next
				274	page. Returns None if there are no more items in the collection.
				275	</pre>
				276	</div>
				277
				278	<div class="method">
				279	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				280	<pre>Patches a single realm.
				281
				282	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	283	name: string, The resource name of the realm, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	284	body: object, The request body.
				285	The object takes the form of:
				286
				287	{ # A realm resource.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	288	"name": "A String", # The resource name of the realm, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`.
				289	"description": "A String", # Human readable description of the realm.
				290	"etag": "A String", # ETag of the resource.
				291	"createTime": "A String", # Output only. The creation time.
				292	"timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones.
				293	"updateTime": "A String", # Output only. The last-modified time.
				294	"labels": { # The labels associated with this realm. Each label is a key-value pair.
				295	"a_key": "A String",
				296	},
				297	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	298
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	299	updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	300	x__xgafv: string, V1 error format.
				301	Allowed values
				302	1 - v1 error format
				303	2 - v2 error format
				304
				305	Returns:
				306	An object of the form:
				307
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	308	{ # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	309	"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	310	"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	311	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	312	{
				313	"a_key": "", # Properties of the object. Contains field @type with type URL.
				314	},
				315	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	316	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	317	},
				318	"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
				319	"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
				320	"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
				321	"a_key": "", # Properties of the object. Contains field @type with type URL.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	322	},
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	323	"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
				324	"a_key": "", # Properties of the object. Contains field @type with type URL.
				325	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	326	}</pre>
				327	</div>
				328
				329	<div class="method">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	330	<code class="details" id="previewUpdate">previewUpdate(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	331	<pre>Previews patches to a single realm.
				332
				333	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	334	name: string, The resource name of the realm, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	335	body: object, The request body.
				336	The object takes the form of:
				337
				338	{ # A realm resource.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	339	"name": "A String", # The resource name of the realm, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. For example, `projects/my-project/locations/{location}/realms/my-realm`.
				340	"description": "A String", # Human readable description of the realm.
				341	"etag": "A String", # ETag of the resource.
				342	"createTime": "A String", # Output only. The creation time.
				343	"timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value of this field must be from the IANA time zone database: https://www.iana.org/time-zones.
				344	"updateTime": "A String", # Output only. The last-modified time.
				345	"labels": { # The labels associated with this realm. Each label is a key-value pair.
				346	"a_key": "A String",
				347	},
				348	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	349
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	350	previewTime: string, Optional. The target timestamp to compute the preview.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	351	updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	352	x__xgafv: string, V1 error format.
				353	Allowed values
				354	1 - v1 error format
				355	2 - v2 error format
				356
				357	Returns:
				358	An object of the form:
				359
				360	{ # Response message for RealmsService.PreviewRealmUpdate.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	361	"etag": "A String", # ETag of the realm.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	362	"targetState": { # Encapsulates the Target state. # The target state.
				363	"details": [ # Details about Agones fleets.
				364	{ # Details about the Agones resources.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	365	"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
				366	{ # Details of the target Agones fleet.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	367	"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
				368	"name": "A String", # The name of the Agones fleet.
				369	"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	370	"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	371	"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
				372	},
				373	},
				374	"autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	375	"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
				376	"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
				377	"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	378	},
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	379	"name": "A String", # The name of the Agones autoscaler.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	380	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	381	},
				382	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	383	"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
				384	"gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	385	},
				386	],
				387	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	388	}</pre>
				389	</div>
				390
				391	</body></html>