- 0.58.0 (latest)
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.7
- 0.13.1
- 0.12.1
- 0.11.5
GitHub Repository | Product Reference | REST Documentation | RPC Documentation |
Service Description: Service for managing Deployments.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
DeploymentName name =
DeploymentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[DEPLOYMENT]");
Deployment response = deploymentsClient.getDeployment(name);
}
Note: close() needs to be called on the DeploymentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
Method | Description | Method Variants |
---|---|---|
ListDeployments |
Returns the list of all deployments in the specified Environment. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetDeployment |
Retrieves the specified Deployment. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListLocations |
Lists information about the supported locations for this service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DeploymentsSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DeploymentsSettings deploymentsSettings =
DeploymentsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DeploymentsClient deploymentsClient = DeploymentsClient.create(deploymentsSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DeploymentsSettings deploymentsSettings =
DeploymentsSettings.newBuilder().setEndpoint(myEndpoint).build();
DeploymentsClient deploymentsClient = DeploymentsClient.create(deploymentsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DeploymentsSettings deploymentsSettings = DeploymentsSettings.newHttpJsonBuilder().build();
DeploymentsClient deploymentsClient = DeploymentsClient.create(deploymentsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final DeploymentsClient create()
Constructs an instance of DeploymentsClient with default settings.
Returns | |
---|---|
Type | Description |
DeploymentsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(DeploymentsSettings settings)
public static final DeploymentsClient create(DeploymentsSettings settings)
Constructs an instance of DeploymentsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Parameter | |
---|---|
Name | Description |
settings |
DeploymentsSettings |
Returns | |
---|---|
Type | Description |
DeploymentsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(DeploymentsStub stub)
public static final DeploymentsClient create(DeploymentsStub stub)
Constructs an instance of DeploymentsClient, using the given stub for making calls. This is for advanced usage - prefer using create(DeploymentsSettings).
Parameter | |
---|---|
Name | Description |
stub |
DeploymentsStub |
Returns | |
---|---|
Type | Description |
DeploymentsClient |
Constructors
DeploymentsClient(DeploymentsSettings settings)
protected DeploymentsClient(DeploymentsSettings settings)
Constructs an instance of DeploymentsClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Parameter | |
---|---|
Name | Description |
settings |
DeploymentsSettings |
DeploymentsClient(DeploymentsStub stub)
protected DeploymentsClient(DeploymentsStub stub)
Parameter | |
---|---|
Name | Description |
stub |
DeploymentsStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration |
long |
unit |
TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
getDeployment(DeploymentName name)
public final Deployment getDeployment(DeploymentName name)
Retrieves the specified Deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
DeploymentName name =
DeploymentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[DEPLOYMENT]");
Deployment response = deploymentsClient.getDeployment(name);
}
Parameter | |
---|---|
Name | Description |
name |
DeploymentName Required. The name of the
Deployment. Format: |
Returns | |
---|---|
Type | Description |
Deployment |
getDeployment(GetDeploymentRequest request)
public final Deployment getDeployment(GetDeploymentRequest request)
Retrieves the specified Deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
GetDeploymentRequest request =
GetDeploymentRequest.newBuilder()
.setName(
DeploymentName.of(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[DEPLOYMENT]")
.toString())
.build();
Deployment response = deploymentsClient.getDeployment(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetDeploymentRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Deployment |
getDeployment(String name)
public final Deployment getDeployment(String name)
Retrieves the specified Deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
String name =
DeploymentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[DEPLOYMENT]")
.toString();
Deployment response = deploymentsClient.getDeployment(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the
Deployment. Format: |
Returns | |
---|---|
Type | Description |
Deployment |
getDeploymentCallable()
public final UnaryCallable<GetDeploymentRequest,Deployment> getDeploymentCallable()
Retrieves the specified Deployment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
GetDeploymentRequest request =
GetDeploymentRequest.newBuilder()
.setName(
DeploymentName.of(
"[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[DEPLOYMENT]")
.toString())
.build();
ApiFuture<Deployment> future = deploymentsClient.getDeploymentCallable().futureCall(request);
// Do something.
Deployment response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetDeploymentRequest,Deployment> |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = deploymentsClient.getLocation(request);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = deploymentsClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getSettings()
public final DeploymentsSettings getSettings()
Returns | |
---|---|
Type | Description |
DeploymentsSettings |
getStub()
public DeploymentsStub getStub()
Returns | |
---|---|
Type | Description |
DeploymentsStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listDeployments(EnvironmentName parent)
public final DeploymentsClient.ListDeploymentsPagedResponse listDeployments(EnvironmentName parent)
Returns the list of all deployments in the specified Environment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
EnvironmentName parent =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
for (Deployment element : deploymentsClient.listDeployments(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
EnvironmentName Required. The Environment to
list all environments for. Format: |
Returns | |
---|---|
Type | Description |
DeploymentsClient.ListDeploymentsPagedResponse |
listDeployments(ListDeploymentsRequest request)
public final DeploymentsClient.ListDeploymentsPagedResponse listDeployments(ListDeploymentsRequest request)
Returns the list of all deployments in the specified Environment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
ListDeploymentsRequest request =
ListDeploymentsRequest.newBuilder()
.setParent(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Deployment element : deploymentsClient.listDeployments(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListDeploymentsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
DeploymentsClient.ListDeploymentsPagedResponse |
listDeployments(String parent)
public final DeploymentsClient.ListDeploymentsPagedResponse listDeployments(String parent)
Returns the list of all deployments in the specified Environment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
String parent =
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]").toString();
for (Deployment element : deploymentsClient.listDeployments(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The Environment to
list all environments for. Format: |
Returns | |
---|---|
Type | Description |
DeploymentsClient.ListDeploymentsPagedResponse |
listDeploymentsCallable()
public final UnaryCallable<ListDeploymentsRequest,ListDeploymentsResponse> listDeploymentsCallable()
Returns the list of all deployments in the specified Environment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
ListDeploymentsRequest request =
ListDeploymentsRequest.newBuilder()
.setParent(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListDeploymentsResponse response =
deploymentsClient.listDeploymentsCallable().call(request);
for (Deployment element : response.getDeploymentsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListDeploymentsRequest,ListDeploymentsResponse> |
listDeploymentsPagedCallable()
public final UnaryCallable<ListDeploymentsRequest,DeploymentsClient.ListDeploymentsPagedResponse> listDeploymentsPagedCallable()
Returns the list of all deployments in the specified Environment.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
ListDeploymentsRequest request =
ListDeploymentsRequest.newBuilder()
.setParent(
EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Deployment> future =
deploymentsClient.listDeploymentsPagedCallable().futureCall(request);
// Do something.
for (Deployment element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListDeploymentsRequest,ListDeploymentsPagedResponse> |
listLocations(ListLocationsRequest request)
public final DeploymentsClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : deploymentsClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
DeploymentsClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = deploymentsClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,DeploymentsClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
deploymentsClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()