• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2022 Google LLC
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      https://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 /**
18  * A client to Game Services API
19  *
20  * <p>The interfaces provided are listed below, along with usage samples.
21  *
22  * <p>======================= GameServerClustersServiceClient =======================
23  *
24  * <p>Service Description: The game server cluster maps to Kubernetes clusters running Agones and is
25  * used to manage fleets within clusters.
26  *
27  * <p>Sample for GameServerClustersServiceClient:
28  *
29  * <pre>{@code
30  * // This snippet has been automatically generated and should be regarded as a code template only.
31  * // It will require modifications to work:
32  * // - It may require correct/in-range values for request initialization.
33  * // - It may require specifying regional endpoints when creating the service client as shown in
34  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
35  * try (GameServerClustersServiceClient gameServerClustersServiceClient =
36  *     GameServerClustersServiceClient.create()) {
37  *   GameServerClusterName name =
38  *       GameServerClusterName.of("[PROJECT]", "[LOCATION]", "[REALM]", "[CLUSTER]");
39  *   GameServerCluster response = gameServerClustersServiceClient.getGameServerCluster(name);
40  * }
41  * }</pre>
42  *
43  * <p>======================= GameServerConfigsServiceClient =======================
44  *
45  * <p>Service Description: The game server config configures the game servers in an Agones fleet.
46  *
47  * <p>Sample for GameServerConfigsServiceClient:
48  *
49  * <pre>{@code
50  * // This snippet has been automatically generated and should be regarded as a code template only.
51  * // It will require modifications to work:
52  * // - It may require correct/in-range values for request initialization.
53  * // - It may require specifying regional endpoints when creating the service client as shown in
54  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
55  * try (GameServerConfigsServiceClient gameServerConfigsServiceClient =
56  *     GameServerConfigsServiceClient.create()) {
57  *   GameServerConfigName name =
58  *       GameServerConfigName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]", "[CONFIG]");
59  *   GameServerConfig response = gameServerConfigsServiceClient.getGameServerConfig(name);
60  * }
61  * }</pre>
62  *
63  * <p>======================= GameServerDeploymentsServiceClient =======================
64  *
65  * <p>Service Description: The game server deployment is used to control the deployment of Agones
66  * fleets.
67  *
68  * <p>Sample for GameServerDeploymentsServiceClient:
69  *
70  * <pre>{@code
71  * // This snippet has been automatically generated and should be regarded as a code template only.
72  * // It will require modifications to work:
73  * // - It may require correct/in-range values for request initialization.
74  * // - It may require specifying regional endpoints when creating the service client as shown in
75  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
76  * try (GameServerDeploymentsServiceClient gameServerDeploymentsServiceClient =
77  *     GameServerDeploymentsServiceClient.create()) {
78  *   GameServerDeploymentName name =
79  *       GameServerDeploymentName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT]");
80  *   GameServerDeployment response =
81  *       gameServerDeploymentsServiceClient.getGameServerDeployment(name);
82  * }
83  * }</pre>
84  *
85  * <p>======================= RealmsServiceClient =======================
86  *
87  * <p>Service Description: A realm is a grouping of game server clusters that are considered
88  * interchangeable.
89  *
90  * <p>Sample for RealmsServiceClient:
91  *
92  * <pre>{@code
93  * // This snippet has been automatically generated and should be regarded as a code template only.
94  * // It will require modifications to work:
95  * // - It may require correct/in-range values for request initialization.
96  * // - It may require specifying regional endpoints when creating the service client as shown in
97  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
98  * try (RealmsServiceClient realmsServiceClient = RealmsServiceClient.create()) {
99  *   RealmName name = RealmName.of("[PROJECT]", "[LOCATION]", "[REALM]");
100  *   Realm response = realmsServiceClient.getRealm(name);
101  * }
102  * }</pre>
103  */
104 @Generated("by gapic-generator-java")
105 package com.google.cloud.gaming.v1beta;
106 
107 import javax.annotation.Generated;
108