docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/gameservices_v1.projects.locations.realms.gameServerClusters.html b/docs/dyn/gameservices_v1.projects.locations.realms.gameServerClusters.html
index de7debe..64bd225 100644
--- a/docs/dyn/gameservices_v1.projects.locations.realms.gameServerClusters.html
+++ b/docs/dyn/gameservices_v1.projects.locations.realms.gameServerClusters.html
@@ -75,6 +75,9 @@
<h1><a href="gameservices_v1.html">Game Services API</a> . <a href="gameservices_v1.projects.html">projects</a> . <a href="gameservices_v1.projects.locations.html">locations</a> . <a href="gameservices_v1.projects.locations.realms.html">realms</a> . <a href="gameservices_v1.projects.locations.realms.gameServerClusters.html">gameServerClusters</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#create">create(parent, body=None, gameServerClusterId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new game server cluster in a given project and location.</p>
<p class="toc_element">
@@ -84,7 +87,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single game server cluster.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, orderBy=None, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists game server clusters in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -94,55 +97,43 @@
<p class="firstline">Patches a single game server cluster.</p>
<p class="toc_element">
<code><a href="#previewCreate">previewCreate(parent, body=None, previewTime=None, gameServerClusterId=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Previews creation of a new game server cluster in a given project and</p>
+<p class="firstline">Previews creation of a new game server cluster in a given project and location.</p>
<p class="toc_element">
<code><a href="#previewDelete">previewDelete(name, previewTime=None, x__xgafv=None)</a></code></p>
<p class="firstline">Previews deletion of a single game server cluster.</p>
<p class="toc_element">
- <code><a href="#previewUpdate">previewUpdate(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#previewUpdate">previewUpdate(name, body=None, updateMask=None, previewTime=None, x__xgafv=None)</a></code></p>
<p class="firstline">Previews updating a GameServerCluster.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="create">create(parent, body=None, gameServerClusterId=None, x__xgafv=None)</code>
<pre>Creates a new game server cluster in a given project and location.
Args:
- parent: string, Required. The parent resource name. Uses the form:
-`projects/{project}/locations/{location}/realms/{realm-id}`. (required)
+ parent: string, Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/realms/{realm-id}`. (required)
body: object, The request body.
The object takes the form of:
{ # A game server cluster resource.
+ "description": "A String", # Human readable description of the cluster.
+ "etag": "A String", # ETag of the resource.
"updateTime": "A String", # Output only. The last-modified time.
- "name": "A String", # Required. The resource name of the game server cluster. Uses the form:
- #
- # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
- # For example,
- #
- # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
- "labels": { # The labels associated with this game server cluster. Each label is a
- # key-value pair.
+ "createTime": "A String", # Output only. The creation time.
+ "labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
"a_key": "A String",
},
- "etag": "A String", # ETag of the resource.
- "createTime": "A String", # Output only. The creation time.
- "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to
- # manage game server clusters.
+ "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
- "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.
+ "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.
},
- "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.
+ "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.
},
- "description": "A String", # Human readable description of the cluster.
+ "name": "A String", # Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
}
gameServerClusterId: string, Required. The ID of the game server cluster resource to be created.
@@ -154,48 +145,24 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "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}`.
- "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.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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}`.
+ "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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "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.
+ "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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "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.
},
- "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.
- "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`.
+ "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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
}</pre>
</div>
@@ -204,8 +171,7 @@
<pre>Deletes a single game server cluster.
Args:
- name: string, Required. The name of the game server cluster to delete. Uses the form:
-`projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)
+ name: string, Required. The name of the game server cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -214,48 +180,24 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "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}`.
- "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.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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}`.
+ "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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "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.
+ "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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "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.
},
- "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.
- "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`.
+ "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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
}</pre>
</div>
@@ -264,9 +206,7 @@
<pre>Gets details of a single game server cluster.
Args:
- name: string, Required. The name of the game server cluster to retrieve. Uses the form:
-
-`projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. (required)
+ name: string, Required. The name of the game server cluster to retrieve. Uses the form: `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -276,54 +216,32 @@
An object of the form:
{ # A game server cluster resource.
+ "description": "A String", # Human readable description of the cluster.
+ "etag": "A String", # ETag of the resource.
"updateTime": "A String", # Output only. The last-modified time.
- "name": "A String", # Required. The resource name of the game server cluster. Uses the form:
- #
- # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
- # For example,
- #
- # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
- "labels": { # The labels associated with this game server cluster. Each label is a
- # key-value pair.
+ "createTime": "A String", # Output only. The creation time.
+ "labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
"a_key": "A String",
},
- "etag": "A String", # ETag of the resource.
- "createTime": "A String", # Output only. The creation time.
- "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to
- # manage game server clusters.
+ "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
- "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.
+ "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.
},
- "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.
+ "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.
},
- "description": "A String", # Human readable description of the cluster.
+ "name": "A String", # Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, orderBy=None, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</code>
<pre>Lists game server clusters in a given project and location.
Args:
- parent: string, Required. The parent resource name. Uses the form:
-"projects/{project}/locations/{location}/realms/{realm}". (required)
- orderBy: string, Optional. Specifies the ordering of results following syntax at
-https://cloud.google.com/apis/design/design_patterns#sorting_order.
+ parent: string, Required. The parent resource name. Uses the form: "projects/{project}/locations/{location}/realms/{realm}". (required)
+ orderBy: string, Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.
+ 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.
pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.
- 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.
filter: string, Optional. The filter to apply to list results.
x__xgafv: string, V1 error format.
Allowed values
@@ -337,42 +255,25 @@
"unreachable": [ # List of locations that could not be reached.
"A String",
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
- # results in the list.
"gameServerClusters": [ # The list of game server clusters.
{ # A game server cluster resource.
+ "description": "A String", # Human readable description of the cluster.
+ "etag": "A String", # ETag of the resource.
"updateTime": "A String", # Output only. The last-modified time.
- "name": "A String", # Required. The resource name of the game server cluster. Uses the form:
- #
- # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
- # For example,
- #
- # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
- "labels": { # The labels associated with this game server cluster. Each label is a
- # key-value pair.
+ "createTime": "A String", # Output only. The creation time.
+ "labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
"a_key": "A String",
},
- "etag": "A String", # ETag of the resource.
- "createTime": "A String", # Output only. The creation time.
- "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to
- # manage game server clusters.
+ "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
- "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.
+ "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.
},
- "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.
+ "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.
},
- "description": "A String", # Human readable description of the cluster.
+ "name": "A String", # Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
},
],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>
@@ -395,54 +296,28 @@
<pre>Patches a single game server cluster.
Args:
- name: string, Required. The resource name of the game server cluster. Uses the form:
-
-`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
-For example,
-
-`projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)
+ name: string, Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)
body: object, The request body.
The object takes the form of:
{ # A game server cluster resource.
+ "description": "A String", # Human readable description of the cluster.
+ "etag": "A String", # ETag of the resource.
"updateTime": "A String", # Output only. The last-modified time.
- "name": "A String", # Required. The resource name of the game server cluster. Uses the form:
- #
- # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
- # For example,
- #
- # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
- "labels": { # The labels associated with this game server cluster. Each label is a
- # key-value pair.
+ "createTime": "A String", # Output only. The creation time.
+ "labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
"a_key": "A String",
},
- "etag": "A String", # ETag of the resource.
- "createTime": "A String", # Output only. The creation time.
- "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to
- # manage game server clusters.
+ "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
- "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.
+ "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.
},
- "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.
+ "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.
},
- "description": "A String", # Human readable description of the cluster.
+ "name": "A String", # Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
}
- 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
+ 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
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -451,93 +326,51 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "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}`.
- "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.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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}`.
+ "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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "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.
+ "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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "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.
},
- "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.
- "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`.
+ "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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
}</pre>
</div>
<div class="method">
<code class="details" id="previewCreate">previewCreate(parent, body=None, previewTime=None, gameServerClusterId=None, x__xgafv=None)</code>
- <pre>Previews creation of a new game server cluster in a given project and
-location.
+ <pre>Previews creation of a new game server cluster in a given project and location.
Args:
- parent: string, Required. The parent resource name. Uses the form:
-`projects/{project}/locations/{location}/realms/{realm}`. (required)
+ parent: string, Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. (required)
body: object, The request body.
The object takes the form of:
{ # A game server cluster resource.
+ "description": "A String", # Human readable description of the cluster.
+ "etag": "A String", # ETag of the resource.
"updateTime": "A String", # Output only. The last-modified time.
- "name": "A String", # Required. The resource name of the game server cluster. Uses the form:
- #
- # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
- # For example,
- #
- # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
- "labels": { # The labels associated with this game server cluster. Each label is a
- # key-value pair.
+ "createTime": "A String", # Output only. The creation time.
+ "labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
"a_key": "A String",
},
- "etag": "A String", # ETag of the resource.
- "createTime": "A String", # Output only. The creation time.
- "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to
- # manage game server clusters.
+ "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
- "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.
+ "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.
},
- "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.
+ "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.
},
- "description": "A String", # Human readable description of the cluster.
+ "name": "A String", # Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
}
previewTime: string, Optional. The target timestamp to compute the preview.
@@ -550,41 +383,28 @@
Returns:
An object of the form:
- { # Response message for
- # GameServerClustersService.PreviewCreateGameServerCluster.
+ { # Response message for GameServerClustersService.PreviewCreateGameServerCluster.
"targetState": { # Encapsulates the Target state. # The target state.
"details": [ # Details about Agones fleets.
{ # Details about the Agones resources.
- "gameServerDeploymentName": "A String", # The game server deployment name. Uses the form:
- #
- # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
- "gameServerClusterName": "A String", # The game server cluster name. Uses the form:
- #
- # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
+ "gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
+ "gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
{ # Details of the target Agones fleet.
- "autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
- "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
- # Details about the Agones autoscaler spec.
- "gameServerConfigName": "A String", # The game server config resource. Uses the form:
- #
- # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
- "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
- # the Agones fleet or Agones autoscaler spec.
- },
- "name": "A String", # The name of the Agones autoscaler.
- },
"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
"name": "A String", # The name of the Agones fleet.
- "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
- # The Agones fleet spec source.
- "gameServerConfigName": "A String", # The game server config resource. Uses the form:
- #
- # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
- "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
- # the Agones fleet or Agones autoscaler spec.
+ "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
+ "gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
+ "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
},
},
+ "autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
+ "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
+ "gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
+ "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
+ },
+ "name": "A String", # The name of the Agones autoscaler.
+ },
},
],
},
@@ -599,8 +419,7 @@
<pre>Previews deletion of a single game server cluster.
Args:
- name: string, Required. The name of the game server cluster to delete. Uses the form:
-`projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)
+ name: string, Required. The name of the game server cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)
previewTime: string, Optional. The target timestamp to compute the preview.
x__xgafv: string, V1 error format.
Allowed values
@@ -610,42 +429,29 @@
Returns:
An object of the form:
- { # Response message for
- # GameServerClustersService.PreviewDeleteGameServerCluster.
+ { # Response message for GameServerClustersService.PreviewDeleteGameServerCluster.
"etag": "A String", # The ETag of the game server cluster.
"targetState": { # Encapsulates the Target state. # The target state.
"details": [ # Details about Agones fleets.
{ # Details about the Agones resources.
- "gameServerDeploymentName": "A String", # The game server deployment name. Uses the form:
- #
- # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
- "gameServerClusterName": "A String", # The game server cluster name. Uses the form:
- #
- # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
+ "gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
+ "gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
{ # Details of the target Agones fleet.
- "autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
- "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
- # Details about the Agones autoscaler spec.
- "gameServerConfigName": "A String", # The game server config resource. Uses the form:
- #
- # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
- "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
- # the Agones fleet or Agones autoscaler spec.
- },
- "name": "A String", # The name of the Agones autoscaler.
- },
"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
"name": "A String", # The name of the Agones fleet.
- "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
- # The Agones fleet spec source.
- "gameServerConfigName": "A String", # The game server config resource. Uses the form:
- #
- # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
- "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
- # the Agones fleet or Agones autoscaler spec.
+ "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
+ "gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
+ "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
},
},
+ "autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
+ "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
+ "gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
+ "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
+ },
+ "name": "A String", # The name of the Agones autoscaler.
+ },
},
],
},
@@ -655,59 +461,33 @@
</div>
<div class="method">
- <code class="details" id="previewUpdate">previewUpdate(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="previewUpdate">previewUpdate(name, body=None, updateMask=None, previewTime=None, x__xgafv=None)</code>
<pre>Previews updating a GameServerCluster.
Args:
- name: string, Required. The resource name of the game server cluster. Uses the form:
-
-`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
-For example,
-
-`projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)
+ name: string, Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)
body: object, The request body.
The object takes the form of:
{ # A game server cluster resource.
+ "description": "A String", # Human readable description of the cluster.
+ "etag": "A String", # ETag of the resource.
"updateTime": "A String", # Output only. The last-modified time.
- "name": "A String", # Required. The resource name of the game server cluster. Uses the form:
- #
- # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
- # For example,
- #
- # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
- "labels": { # The labels associated with this game server cluster. Each label is a
- # key-value pair.
+ "createTime": "A String", # Output only. The creation time.
+ "labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
"a_key": "A String",
},
- "etag": "A String", # ETag of the resource.
- "createTime": "A String", # Output only. The creation time.
- "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to
- # manage game server clusters.
+ "connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
- "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.
+ "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.
},
- "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.
+ "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.
},
- "description": "A String", # Human readable description of the cluster.
+ "name": "A String", # Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
}
+ 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
previewTime: string, Optional. The target timestamp to compute the preview.
- 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
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -721,36 +501,24 @@
"targetState": { # Encapsulates the Target state. # The target state.
"details": [ # Details about Agones fleets.
{ # Details about the Agones resources.
- "gameServerDeploymentName": "A String", # The game server deployment name. Uses the form:
- #
- # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
- "gameServerClusterName": "A String", # The game server cluster name. Uses the form:
- #
- # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
+ "gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
+ "gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
{ # Details of the target Agones fleet.
- "autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
- "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
- # Details about the Agones autoscaler spec.
- "gameServerConfigName": "A String", # The game server config resource. Uses the form:
- #
- # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
- "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
- # the Agones fleet or Agones autoscaler spec.
- },
- "name": "A String", # The name of the Agones autoscaler.
- },
"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
"name": "A String", # The name of the Agones fleet.
- "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
- # The Agones fleet spec source.
- "gameServerConfigName": "A String", # The game server config resource. Uses the form:
- #
- # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
- "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
- # the Agones fleet or Agones autoscaler spec.
+ "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
+ "gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
+ "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
},
},
+ "autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
+ "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
+ "gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
+ "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
+ },
+ "name": "A String", # The name of the Agones autoscaler.
+ },
},
],
},