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

blob: 227493cd10771c6e32d7d8cdbcc8a0e039b1b23c [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> . <a href="gameservices_v1beta.projects.locations.realms.gameServerClusters.html">gameServerClusters</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	81	<code><a href="#create">create(parent, body=None, gameServerClusterId=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Creates a new game server cluster in a given project and location.</p>
				83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Deletes a single game server cluster.</p>
				86	<p class="toc_element">
				87	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Gets details of a single game server cluster.</p>
				89	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	90	<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	91	<p class="firstline">Lists game server clusters in a given project and location.</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">
				96	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Patches a single game server cluster.</p>
				98	<p class="toc_element">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	99	<code><a href="#previewCreate">previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	100	<p class="firstline">Previews creation of a new game server cluster in a given project and location.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	101	<p class="toc_element">
				102	<code><a href="#previewDelete">previewDelete(name, previewTime=None, x__xgafv=None)</a></code></p>
				103	<p class="firstline">Previews deletion of a single game server cluster.</p>
				104	<p class="toc_element">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	105	<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]	106	<p class="firstline">Previews updating a GameServerCluster.</p>
				107	<h3>Method Details</h3>
				108	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	109	<code class="details" id="close">close()</code>
				110	<pre>Close httplib2 connections.</pre>
				111	</div>
				112
				113	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	114	<code class="details" id="create">create(parent, body=None, gameServerClusterId=None, x__xgafv=None)</code>
				115	<pre>Creates a new game server cluster in a given project and location.
				116
				117	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	118	parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{location}/realms/{realm-id}`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	119	body: object, The request body.
				120	The object takes the form of:
				121
				122	{ # A game server cluster resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	123	"allocationPriority": "A String", # Optional. The allocation priority assigned to the game server cluster. Game server clusters receive new game server allocations based on the relative allocation priorites set for each cluster, if the realm is configured for multicluster allocation.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	124	"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
				125	"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
				126	"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	127	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	128	"gkeHubClusterReference": { # GkeHubClusterReference represents a reference to a Kubernetes cluster registered through GKE Hub. # Reference to a Kubernetes cluster registered through GKE Hub. See https://cloud.google.com/anthos/multicluster-management/ for more information about registering Kubernetes clusters.
				129	"membership": "A String", # The full or partial name of a GKE Hub membership, using one of the following forms: * `https://gkehub.googleapis.com/v1beta1/projects/{project_id}/locations/global/memberships/{membership_id}` * `projects/{project_id}/locations/global/memberships/{membership_id}` * `{membership_id}` If project is not specified, the project of the GameServerCluster resource is used to generate the full name of the GKE Hub membership.
				130	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	131	"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.
				132	},
				133	"createTime": "A String", # Output only. The creation time.
				134	"description": "A String", # Human readable description of the cluster.
				135	"etag": "A String", # ETag of the resource.
				136	"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
				137	"a_key": "A String",
				138	},
				139	"name": "A String", # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
				140	"updateTime": "A String", # Output only. The last-modified time.
				141	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	142
				143	gameServerClusterId: string, Required. The ID of the game server cluster resource to be created.
				144	x__xgafv: string, V1 error format.
				145	Allowed values
				146	1 - v1 error format
				147	2 - v2 error format
				148
				149	Returns:
				150	An object of the form:
				151
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	152	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	153	"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.
				154	"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.
				155	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				156	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				157	{
				158	"a_key": "", # Properties of the object. Contains field @type with type URL.
				159	},
				160	],
				161	"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.
				162	},
				163	"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.
				164	"a_key": "", # Properties of the object. Contains field @type with type URL.
				165	},
				166	"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}`.
				167	"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`.
				168	"a_key": "", # Properties of the object. Contains field @type with type URL.
				169	},
				170	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	171	</div>
				172
				173	<div class="method">
				174	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				175	<pre>Deletes a single game server cluster.
				176
				177	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	178	name: string, Required. The name of the game server cluster to delete, in the following form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	179	x__xgafv: string, V1 error format.
				180	Allowed values
				181	1 - v1 error format
				182	2 - v2 error format
				183
				184	Returns:
				185	An object of the form:
				186
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	187	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	188	"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.
				189	"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.
				190	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				191	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				192	{
				193	"a_key": "", # Properties of the object. Contains field @type with type URL.
				194	},
				195	],
				196	"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.
				197	},
				198	"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.
				199	"a_key": "", # Properties of the object. Contains field @type with type URL.
				200	},
				201	"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}`.
				202	"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`.
				203	"a_key": "", # Properties of the object. Contains field @type with type URL.
				204	},
				205	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	206	</div>
				207
				208	<div class="method">
				209	<code class="details" id="get">get(name, x__xgafv=None)</code>
				210	<pre>Gets details of a single game server cluster.
				211
				212	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	213	name: string, Required. The name of the game server cluster to retrieve, in the following form: `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	214	x__xgafv: string, V1 error format.
				215	Allowed values
				216	1 - v1 error format
				217	2 - v2 error format
				218
				219	Returns:
				220	An object of the form:
				221
				222	{ # A game server cluster resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	223	"allocationPriority": "A String", # Optional. The allocation priority assigned to the game server cluster. Game server clusters receive new game server allocations based on the relative allocation priorites set for each cluster, if the realm is configured for multicluster allocation.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	224	"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
				225	"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
				226	"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
				227	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	228	"gkeHubClusterReference": { # GkeHubClusterReference represents a reference to a Kubernetes cluster registered through GKE Hub. # Reference to a Kubernetes cluster registered through GKE Hub. See https://cloud.google.com/anthos/multicluster-management/ for more information about registering Kubernetes clusters.
				229	"membership": "A String", # The full or partial name of a GKE Hub membership, using one of the following forms: * `https://gkehub.googleapis.com/v1beta1/projects/{project_id}/locations/global/memberships/{membership_id}` * `projects/{project_id}/locations/global/memberships/{membership_id}` * `{membership_id}` If project is not specified, the project of the GameServerCluster resource is used to generate the full name of the GKE Hub membership.
				230	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	231	"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.
				232	},
				233	"createTime": "A String", # Output only. The creation time.
				234	"description": "A String", # Human readable description of the cluster.
				235	"etag": "A String", # ETag of the resource.
				236	"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
				237	"a_key": "A String",
				238	},
				239	"name": "A String", # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
				240	"updateTime": "A String", # Output only. The last-modified time.
				241	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	242	</div>
				243
				244	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	245	<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	246	<pre>Lists game server clusters in a given project and location.
				247
				248	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	249	parent: string, Required. The parent resource name, in the following form: "projects/{project}/locations/{location}/realms/{realm}". (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	250	filter: string, Optional. The filter to apply to list results.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	251	orderBy: string, Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	252	pageSize: integer, Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	253	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]	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
				262	{ # Response message for GameServerClustersService.ListGameServerClusters.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	263	"gameServerClusters": [ # The list of game server clusters.
				264	{ # A game server cluster resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	265	"allocationPriority": "A String", # Optional. The allocation priority assigned to the game server cluster. Game server clusters receive new game server allocations based on the relative allocation priorites set for each cluster, if the realm is configured for multicluster allocation.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	266	"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
				267	"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
				268	"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	269	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	270	"gkeHubClusterReference": { # GkeHubClusterReference represents a reference to a Kubernetes cluster registered through GKE Hub. # Reference to a Kubernetes cluster registered through GKE Hub. See https://cloud.google.com/anthos/multicluster-management/ for more information about registering Kubernetes clusters.
				271	"membership": "A String", # The full or partial name of a GKE Hub membership, using one of the following forms: * `https://gkehub.googleapis.com/v1beta1/projects/{project_id}/locations/global/memberships/{membership_id}` * `projects/{project_id}/locations/global/memberships/{membership_id}` * `{membership_id}` If project is not specified, the project of the GameServerCluster resource is used to generate the full name of the GKE Hub membership.
				272	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	273	"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.
				274	},
				275	"createTime": "A String", # Output only. The creation time.
				276	"description": "A String", # Human readable description of the cluster.
				277	"etag": "A String", # ETag of the resource.
				278	"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
				279	"a_key": "A String",
				280	},
				281	"name": "A String", # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
				282	"updateTime": "A String", # Output only. The last-modified time.
				283	},
				284	],
				285	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
				286	"unreachable": [ # List of locations that could not be reached.
				287	"A String",
				288	],
				289	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	290	</div>
				291
				292	<div class="method">
				293	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				294	<pre>Retrieves the next page of results.
				295
				296	Args:
				297	previous_request: The request for the previous page. (required)
				298	previous_response: The response from the request for the previous page. (required)
				299
				300	Returns:
				301	A request object that you can call 'execute()' on to request the next
				302	page. Returns None if there are no more items in the collection.
				303	</pre>
				304	</div>
				305
				306	<div class="method">
				307	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				308	<pre>Patches a single game server cluster.
				309
				310	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	311	name: string, Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	312	body: object, The request body.
				313	The object takes the form of:
				314
				315	{ # A game server cluster resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	316	"allocationPriority": "A String", # Optional. The allocation priority assigned to the game server cluster. Game server clusters receive new game server allocations based on the relative allocation priorites set for each cluster, if the realm is configured for multicluster allocation.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	317	"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
				318	"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
				319	"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	320	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	321	"gkeHubClusterReference": { # GkeHubClusterReference represents a reference to a Kubernetes cluster registered through GKE Hub. # Reference to a Kubernetes cluster registered through GKE Hub. See https://cloud.google.com/anthos/multicluster-management/ for more information about registering Kubernetes clusters.
				322	"membership": "A String", # The full or partial name of a GKE Hub membership, using one of the following forms: * `https://gkehub.googleapis.com/v1beta1/projects/{project_id}/locations/global/memberships/{membership_id}` * `projects/{project_id}/locations/global/memberships/{membership_id}` * `{membership_id}` If project is not specified, the project of the GameServerCluster resource is used to generate the full name of the GKE Hub membership.
				323	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	324	"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.
				325	},
				326	"createTime": "A String", # Output only. The creation time.
				327	"description": "A String", # Human readable description of the cluster.
				328	"etag": "A String", # ETag of the resource.
				329	"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
				330	"a_key": "A String",
				331	},
				332	"name": "A String", # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
				333	"updateTime": "A String", # Output only. The last-modified time.
				334	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	335
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	336	updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. 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]	337	x__xgafv: string, V1 error format.
				338	Allowed values
				339	1 - v1 error format
				340	2 - v2 error format
				341
				342	Returns:
				343	An object of the form:
				344
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	345	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	346	"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.
				347	"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.
				348	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				349	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				350	{
				351	"a_key": "", # Properties of the object. Contains field @type with type URL.
				352	},
				353	],
				354	"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.
				355	},
				356	"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.
				357	"a_key": "", # Properties of the object. Contains field @type with type URL.
				358	},
				359	"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}`.
				360	"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`.
				361	"a_key": "", # Properties of the object. Contains field @type with type URL.
				362	},
				363	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	364	</div>
				365
				366	<div class="method">
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	367	<code class="details" id="previewCreate">previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	368	<pre>Previews creation of a new game server cluster in a given project and location.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	369
				370	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	371	parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	372	body: object, The request body.
				373	The object takes the form of:
				374
				375	{ # A game server cluster resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	376	"allocationPriority": "A String", # Optional. The allocation priority assigned to the game server cluster. Game server clusters receive new game server allocations based on the relative allocation priorites set for each cluster, if the realm is configured for multicluster allocation.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	377	"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
				378	"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
				379	"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	380	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	381	"gkeHubClusterReference": { # GkeHubClusterReference represents a reference to a Kubernetes cluster registered through GKE Hub. # Reference to a Kubernetes cluster registered through GKE Hub. See https://cloud.google.com/anthos/multicluster-management/ for more information about registering Kubernetes clusters.
				382	"membership": "A String", # The full or partial name of a GKE Hub membership, using one of the following forms: * `https://gkehub.googleapis.com/v1beta1/projects/{project_id}/locations/global/memberships/{membership_id}` * `projects/{project_id}/locations/global/memberships/{membership_id}` * `{membership_id}` If project is not specified, the project of the GameServerCluster resource is used to generate the full name of the GKE Hub membership.
				383	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	384	"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.
				385	},
				386	"createTime": "A String", # Output only. The creation time.
				387	"description": "A String", # Human readable description of the cluster.
				388	"etag": "A String", # ETag of the resource.
				389	"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
				390	"a_key": "A String",
				391	},
				392	"name": "A String", # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
				393	"updateTime": "A String", # Output only. The last-modified time.
				394	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	395
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	396	gameServerClusterId: string, Required. The ID of the game server cluster resource to be created.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	397	previewTime: string, Optional. The target timestamp to compute the preview.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	398	x__xgafv: string, V1 error format.
				399	Allowed values
				400	1 - v1 error format
				401	2 - v2 error format
				402
				403	Returns:
				404	An object of the form:
				405
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	406	{ # Response message for GameServerClustersService.PreviewCreateGameServerCluster.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	407	"etag": "A String", # The ETag of the game server cluster.
				408	"targetState": { # Encapsulates the Target state. # The target state.
				409	"details": [ # Details about Agones fleets.
				410	{ # Details about the Agones resources.
				411	"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
				412	{ # Details of the target Agones fleet.
				413	"autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
				414	"name": "A String", # The name of the Agones autoscaler.
				415	"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
				416	"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
				417	"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	418	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	419	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	420	"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
				421	"name": "A String", # The name of the Agones fleet.
				422	"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
				423	"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
				424	"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
				425	},
				426	},
				427	},
				428	],
				429	"gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
				430	"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
				431	},
				432	],
				433	},
				434	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	435	</div>
				436
				437	<div class="method">
				438	<code class="details" id="previewDelete">previewDelete(name, previewTime=None, x__xgafv=None)</code>
				439	<pre>Previews deletion of a single game server cluster.
				440
				441	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	442	name: string, Required. The name of the game server cluster to delete, in the following form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	443	previewTime: string, Optional. The target timestamp to compute the preview.
				444	x__xgafv: string, V1 error format.
				445	Allowed values
				446	1 - v1 error format
				447	2 - v2 error format
				448
				449	Returns:
				450	An object of the form:
				451
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	452	{ # Response message for GameServerClustersService.PreviewDeleteGameServerCluster.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	453	"etag": "A String", # The ETag of the game server cluster.
				454	"targetState": { # Encapsulates the Target state. # The target state.
				455	"details": [ # Details about Agones fleets.
				456	{ # Details about the Agones resources.
				457	"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
				458	{ # Details of the target Agones fleet.
				459	"autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
				460	"name": "A String", # The name of the Agones autoscaler.
				461	"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
				462	"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
				463	"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	464	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	465	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	466	"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
				467	"name": "A String", # The name of the Agones fleet.
				468	"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
				469	"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
				470	"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
				471	},
				472	},
				473	},
				474	],
				475	"gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
				476	"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
				477	},
				478	],
				479	},
				480	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	481	</div>
				482
				483	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	484	<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]	485	<pre>Previews updating a GameServerCluster.
				486
				487	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	488	name: string, Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	489	body: object, The request body.
				490	The object takes the form of:
				491
				492	{ # A game server cluster resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	493	"allocationPriority": "A String", # Optional. The allocation priority assigned to the game server cluster. Game server clusters receive new game server allocations based on the relative allocation priorites set for each cluster, if the realm is configured for multicluster allocation.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	494	"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
				495	"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
				496	"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	497	},
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	498	"gkeHubClusterReference": { # GkeHubClusterReference represents a reference to a Kubernetes cluster registered through GKE Hub. # Reference to a Kubernetes cluster registered through GKE Hub. See https://cloud.google.com/anthos/multicluster-management/ for more information about registering Kubernetes clusters.
				499	"membership": "A String", # The full or partial name of a GKE Hub membership, using one of the following forms: * `https://gkehub.googleapis.com/v1beta1/projects/{project_id}/locations/global/memberships/{membership_id}` * `projects/{project_id}/locations/global/memberships/{membership_id}` * `{membership_id}` If project is not specified, the project of the GameServerCluster resource is used to generate the full name of the GKE Hub membership.
				500	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	501	"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.
				502	},
				503	"createTime": "A String", # Output only. The creation time.
				504	"description": "A String", # Human readable description of the cluster.
				505	"etag": "A String", # ETag of the resource.
				506	"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
				507	"a_key": "A String",
				508	},
				509	"name": "A String", # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
				510	"updateTime": "A String", # Output only. The last-modified time.
				511	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	512
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	513	previewTime: string, Optional. The target timestamp to compute the preview.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	514	updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. 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]	515	x__xgafv: string, V1 error format.
				516	Allowed values
				517	1 - v1 error format
				518	2 - v2 error format
				519
				520	Returns:
				521	An object of the form:
				522
				523	{ # Response message for GameServerClustersService.PreviewUpdateGameServerCluster
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	524	"etag": "A String", # The ETag of the game server cluster.
				525	"targetState": { # Encapsulates the Target state. # The target state.
				526	"details": [ # Details about Agones fleets.
				527	{ # Details about the Agones resources.
				528	"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
				529	{ # Details of the target Agones fleet.
				530	"autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
				531	"name": "A String", # The name of the Agones autoscaler.
				532	"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
				533	"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
				534	"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	535	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	536	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	537	"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
				538	"name": "A String", # The name of the Agones fleet.
				539	"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
				540	"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
				541	"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
				542	},
				543	},
				544	},
				545	],
				546	"gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
				547	"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
				548	},
				549	],
				550	},
				551	}</pre>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	552	</div>
				553
				554	</body></html>