| GitHub Repository | Product Reference |
Service Description: Deployment service allows users to manage deployments of Frameworks and Cloud Controls on a target resource.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
FrameworkDeploymentName name =
FrameworkDeploymentName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]");
FrameworkDeployment response = deploymentClient.getFrameworkDeployment(name);
}
Note: close() needs to be called on the DeploymentClient 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 |
|---|---|---|
CreateFrameworkDeployment |
Creates a framework deployment in a given parent resource. A framework deployment lets you assign a particular framework version to an organization, folder, or project so that you can control and monitor those resources using the framework's cloud controls. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteFrameworkDeployment |
Deletes a framework deployment. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetFrameworkDeployment |
Gets details about a framework 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.
|
ListFrameworkDeployments |
Lists the framework deployments in a given parent resource. |
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.
|
GetCloudControlDeployment |
Gets details about a cloud control 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.
|
ListCloudControlDeployments |
Lists the cloud conrol deployments in a given parent resource. |
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 DeploymentSettings 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
DeploymentSettings deploymentSettings =
DeploymentSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DeploymentClient deploymentClient = DeploymentClient.create(deploymentSettings);
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
DeploymentSettings deploymentSettings =
DeploymentSettings.newBuilder().setEndpoint(myEndpoint).build();
DeploymentClient deploymentClient = DeploymentClient.create(deploymentSettings);
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
DeploymentSettings deploymentSettings = DeploymentSettings.newHttpJsonBuilder().build();
DeploymentClient deploymentClient = DeploymentClient.create(deploymentSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final DeploymentClient create()Constructs an instance of DeploymentClient with default settings.
| Returns | |
|---|---|
| Type | Description |
DeploymentClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(DeploymentSettings settings)
public static final DeploymentClient create(DeploymentSettings settings)Constructs an instance of DeploymentClient, 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 |
DeploymentSettings |
| Returns | |
|---|---|
| Type | Description |
DeploymentClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(DeploymentStub stub)
public static final DeploymentClient create(DeploymentStub stub)Constructs an instance of DeploymentClient, using the given stub for making calls. This is for advanced usage - prefer using create(DeploymentSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
DeploymentStub |
| Returns | |
|---|---|
| Type | Description |
DeploymentClient |
|
Constructors
DeploymentClient(DeploymentSettings settings)
protected DeploymentClient(DeploymentSettings settings)Constructs an instance of DeploymentClient, 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 |
DeploymentSettings |
DeploymentClient(DeploymentStub stub)
protected DeploymentClient(DeploymentStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
DeploymentStub |
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()createFrameworkDeploymentAsync(CreateFrameworkDeploymentRequest request)
public final OperationFuture<FrameworkDeployment,OperationMetadata> createFrameworkDeploymentAsync(CreateFrameworkDeploymentRequest request)Creates a framework deployment in a given parent resource. A framework deployment lets you assign a particular framework version to an organization, folder, or project so that you can control and monitor those resources using the framework's cloud controls.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
CreateFrameworkDeploymentRequest request =
CreateFrameworkDeploymentRequest.newBuilder()
.setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
.setFrameworkDeploymentId("frameworkDeploymentId-1244700706")
.setFrameworkDeployment(FrameworkDeployment.newBuilder().build())
.build();
FrameworkDeployment response = deploymentClient.createFrameworkDeploymentAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateFrameworkDeploymentRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<FrameworkDeployment,OperationMetadata> |
|
createFrameworkDeploymentAsync(OrganizationLocationName parent, FrameworkDeployment frameworkDeployment, String frameworkDeploymentId)
public final OperationFuture<FrameworkDeployment,OperationMetadata> createFrameworkDeploymentAsync(OrganizationLocationName parent, FrameworkDeployment frameworkDeployment, String frameworkDeploymentId)Creates a framework deployment in a given parent resource. A framework deployment lets you assign a particular framework version to an organization, folder, or project so that you can control and monitor those resources using the framework's cloud controls.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
FrameworkDeployment frameworkDeployment = FrameworkDeployment.newBuilder().build();
String frameworkDeploymentId = "frameworkDeploymentId-1244700706";
FrameworkDeployment response =
deploymentClient
.createFrameworkDeploymentAsync(parent, frameworkDeployment, frameworkDeploymentId)
.get();
}
| Parameters | |
|---|---|
| Name | Description |
parent |
OrganizationLocationNameRequired. The parent resource of the framework deployment in the format
|
frameworkDeployment |
FrameworkDeploymentRequired. The framework deployment that you're creating. |
frameworkDeploymentId |
StringOptional. An identifier for the framework deployment that's unique in scope of the parent. If you don't specify a value, then a random UUID is generated. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<FrameworkDeployment,OperationMetadata> |
|
createFrameworkDeploymentAsync(String parent, FrameworkDeployment frameworkDeployment, String frameworkDeploymentId)
public final OperationFuture<FrameworkDeployment,OperationMetadata> createFrameworkDeploymentAsync(String parent, FrameworkDeployment frameworkDeployment, String frameworkDeploymentId)Creates a framework deployment in a given parent resource. A framework deployment lets you assign a particular framework version to an organization, folder, or project so that you can control and monitor those resources using the framework's cloud controls.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
FrameworkDeployment frameworkDeployment = FrameworkDeployment.newBuilder().build();
String frameworkDeploymentId = "frameworkDeploymentId-1244700706";
FrameworkDeployment response =
deploymentClient
.createFrameworkDeploymentAsync(parent, frameworkDeployment, frameworkDeploymentId)
.get();
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent resource of the framework deployment in the format
|
frameworkDeployment |
FrameworkDeploymentRequired. The framework deployment that you're creating. |
frameworkDeploymentId |
StringOptional. An identifier for the framework deployment that's unique in scope of the parent. If you don't specify a value, then a random UUID is generated. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<FrameworkDeployment,OperationMetadata> |
|
createFrameworkDeploymentCallable()
public final UnaryCallable<CreateFrameworkDeploymentRequest,Operation> createFrameworkDeploymentCallable()Creates a framework deployment in a given parent resource. A framework deployment lets you assign a particular framework version to an organization, folder, or project so that you can control and monitor those resources using the framework's cloud controls.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
CreateFrameworkDeploymentRequest request =
CreateFrameworkDeploymentRequest.newBuilder()
.setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
.setFrameworkDeploymentId("frameworkDeploymentId-1244700706")
.setFrameworkDeployment(FrameworkDeployment.newBuilder().build())
.build();
ApiFuture<Operation> future =
deploymentClient.createFrameworkDeploymentCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateFrameworkDeploymentRequest,Operation> |
|
createFrameworkDeploymentOperationCallable()
public final OperationCallable<CreateFrameworkDeploymentRequest,FrameworkDeployment,OperationMetadata> createFrameworkDeploymentOperationCallable()Creates a framework deployment in a given parent resource. A framework deployment lets you assign a particular framework version to an organization, folder, or project so that you can control and monitor those resources using the framework's cloud controls.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
CreateFrameworkDeploymentRequest request =
CreateFrameworkDeploymentRequest.newBuilder()
.setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
.setFrameworkDeploymentId("frameworkDeploymentId-1244700706")
.setFrameworkDeployment(FrameworkDeployment.newBuilder().build())
.build();
OperationFuture<FrameworkDeployment, OperationMetadata> future =
deploymentClient.createFrameworkDeploymentOperationCallable().futureCall(request);
// Do something.
FrameworkDeployment response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<CreateFrameworkDeploymentRequest,FrameworkDeployment,OperationMetadata> |
|
deleteFrameworkDeploymentAsync(DeleteFrameworkDeploymentRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteFrameworkDeploymentAsync(DeleteFrameworkDeploymentRequest request)Deletes a framework 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
DeleteFrameworkDeploymentRequest request =
DeleteFrameworkDeploymentRequest.newBuilder()
.setName(
FrameworkDeploymentName.of(
"[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]")
.toString())
.setEtag("etag3123477")
.build();
deploymentClient.deleteFrameworkDeploymentAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteFrameworkDeploymentRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> |
|
deleteFrameworkDeploymentAsync(FrameworkDeploymentName name)
public final OperationFuture<Empty,OperationMetadata> deleteFrameworkDeploymentAsync(FrameworkDeploymentName name)Deletes a framework 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
FrameworkDeploymentName name =
FrameworkDeploymentName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]");
deploymentClient.deleteFrameworkDeploymentAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
FrameworkDeploymentNameRequired. The name of the framework deployment that you want to delete, in the
format
|
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> |
|
deleteFrameworkDeploymentAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteFrameworkDeploymentAsync(String name)Deletes a framework 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
String name =
FrameworkDeploymentName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]")
.toString();
deploymentClient.deleteFrameworkDeploymentAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the framework deployment that you want to delete, in the
format
|
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Empty,OperationMetadata> |
|
deleteFrameworkDeploymentCallable()
public final UnaryCallable<DeleteFrameworkDeploymentRequest,Operation> deleteFrameworkDeploymentCallable()Deletes a framework 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
DeleteFrameworkDeploymentRequest request =
DeleteFrameworkDeploymentRequest.newBuilder()
.setName(
FrameworkDeploymentName.of(
"[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]")
.toString())
.setEtag("etag3123477")
.build();
ApiFuture<Operation> future =
deploymentClient.deleteFrameworkDeploymentCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteFrameworkDeploymentRequest,Operation> |
|
deleteFrameworkDeploymentOperationCallable()
public final OperationCallable<DeleteFrameworkDeploymentRequest,Empty,OperationMetadata> deleteFrameworkDeploymentOperationCallable()Deletes a framework 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
DeleteFrameworkDeploymentRequest request =
DeleteFrameworkDeploymentRequest.newBuilder()
.setName(
FrameworkDeploymentName.of(
"[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]")
.toString())
.setEtag("etag3123477")
.build();
OperationFuture<Empty, OperationMetadata> future =
deploymentClient.deleteFrameworkDeploymentOperationCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<DeleteFrameworkDeploymentRequest,Empty,OperationMetadata> |
|
getCloudControlDeployment(CloudControlDeploymentName name)
public final CloudControlDeployment getCloudControlDeployment(CloudControlDeploymentName name)Gets details about a cloud control 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
CloudControlDeploymentName name =
CloudControlDeploymentName.of(
"[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL_DEPLOYMENT]");
CloudControlDeployment response = deploymentClient.getCloudControlDeployment(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
CloudControlDeploymentNameRequired. The name for the cloud control deployment, in the format
|
| Returns | |
|---|---|
| Type | Description |
CloudControlDeployment |
|
getCloudControlDeployment(GetCloudControlDeploymentRequest request)
public final CloudControlDeployment getCloudControlDeployment(GetCloudControlDeploymentRequest request)Gets details about a cloud control 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
GetCloudControlDeploymentRequest request =
GetCloudControlDeploymentRequest.newBuilder()
.setName(
CloudControlDeploymentName.of(
"[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL_DEPLOYMENT]")
.toString())
.build();
CloudControlDeployment response = deploymentClient.getCloudControlDeployment(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetCloudControlDeploymentRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
CloudControlDeployment |
|
getCloudControlDeployment(String name)
public final CloudControlDeployment getCloudControlDeployment(String name)Gets details about a cloud control 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
String name =
CloudControlDeploymentName.of(
"[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL_DEPLOYMENT]")
.toString();
CloudControlDeployment response = deploymentClient.getCloudControlDeployment(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name for the cloud control deployment, in the format
|
| Returns | |
|---|---|
| Type | Description |
CloudControlDeployment |
|
getCloudControlDeploymentCallable()
public final UnaryCallable<GetCloudControlDeploymentRequest,CloudControlDeployment> getCloudControlDeploymentCallable()Gets details about a cloud control 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
GetCloudControlDeploymentRequest request =
GetCloudControlDeploymentRequest.newBuilder()
.setName(
CloudControlDeploymentName.of(
"[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL_DEPLOYMENT]")
.toString())
.build();
ApiFuture<CloudControlDeployment> future =
deploymentClient.getCloudControlDeploymentCallable().futureCall(request);
// Do something.
CloudControlDeployment response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetCloudControlDeploymentRequest,CloudControlDeployment> |
|
getFrameworkDeployment(FrameworkDeploymentName name)
public final FrameworkDeployment getFrameworkDeployment(FrameworkDeploymentName name)Gets details about a framework 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
FrameworkDeploymentName name =
FrameworkDeploymentName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]");
FrameworkDeployment response = deploymentClient.getFrameworkDeployment(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
FrameworkDeploymentNameRequired. The name of the framework deployment, in the format
|
| Returns | |
|---|---|
| Type | Description |
FrameworkDeployment |
|
getFrameworkDeployment(GetFrameworkDeploymentRequest request)
public final FrameworkDeployment getFrameworkDeployment(GetFrameworkDeploymentRequest request)Gets details about a framework 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
GetFrameworkDeploymentRequest request =
GetFrameworkDeploymentRequest.newBuilder()
.setName(
FrameworkDeploymentName.of(
"[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]")
.toString())
.build();
FrameworkDeployment response = deploymentClient.getFrameworkDeployment(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetFrameworkDeploymentRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
FrameworkDeployment |
|
getFrameworkDeployment(String name)
public final FrameworkDeployment getFrameworkDeployment(String name)Gets details about a framework 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
String name =
FrameworkDeploymentName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]")
.toString();
FrameworkDeployment response = deploymentClient.getFrameworkDeployment(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the framework deployment, in the format
|
| Returns | |
|---|---|
| Type | Description |
FrameworkDeployment |
|
getFrameworkDeploymentCallable()
public final UnaryCallable<GetFrameworkDeploymentRequest,FrameworkDeployment> getFrameworkDeploymentCallable()Gets details about a framework 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
GetFrameworkDeploymentRequest request =
GetFrameworkDeploymentRequest.newBuilder()
.setName(
FrameworkDeploymentName.of(
"[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK_DEPLOYMENT]")
.toString())
.build();
ApiFuture<FrameworkDeployment> future =
deploymentClient.getFrameworkDeploymentCallable().futureCall(request);
// Do something.
FrameworkDeployment response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetFrameworkDeploymentRequest,FrameworkDeployment> |
|
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = deploymentClient.getLocation(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.cloud.location.GetLocationRequestThe 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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = deploymentClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
|
getOperationsClient()
public final OperationsClient getOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
getSettings()
public final DeploymentSettings getSettings()| Returns | |
|---|---|
| Type | Description |
DeploymentSettings |
|
getStub()
public DeploymentStub getStub()| Returns | |
|---|---|
| Type | Description |
DeploymentStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listCloudControlDeployments(ListCloudControlDeploymentsRequest request)
public final DeploymentClient.ListCloudControlDeploymentsPagedResponse listCloudControlDeployments(ListCloudControlDeploymentsRequest request)Lists the cloud conrol deployments in a given parent resource.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
ListCloudControlDeploymentsRequest request =
ListCloudControlDeploymentsRequest.newBuilder()
.setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (CloudControlDeployment element :
deploymentClient.listCloudControlDeployments(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListCloudControlDeploymentsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
DeploymentClient.ListCloudControlDeploymentsPagedResponse |
|
listCloudControlDeployments(OrganizationLocationName parent)
public final DeploymentClient.ListCloudControlDeploymentsPagedResponse listCloudControlDeployments(OrganizationLocationName parent)Lists the cloud conrol deployments in a given parent resource.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
for (CloudControlDeployment element :
deploymentClient.listCloudControlDeployments(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
OrganizationLocationNameRequired. The parent resource for the cloud control deployment, in the format
|
| Returns | |
|---|---|
| Type | Description |
DeploymentClient.ListCloudControlDeploymentsPagedResponse |
|
listCloudControlDeployments(String parent)
public final DeploymentClient.ListCloudControlDeploymentsPagedResponse listCloudControlDeployments(String parent)Lists the cloud conrol deployments in a given parent resource.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
for (CloudControlDeployment element :
deploymentClient.listCloudControlDeployments(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent resource for the cloud control deployment, in the format
|
| Returns | |
|---|---|
| Type | Description |
DeploymentClient.ListCloudControlDeploymentsPagedResponse |
|
listCloudControlDeploymentsCallable()
public final UnaryCallable<ListCloudControlDeploymentsRequest,ListCloudControlDeploymentsResponse> listCloudControlDeploymentsCallable()Lists the cloud conrol deployments in a given parent resource.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
ListCloudControlDeploymentsRequest request =
ListCloudControlDeploymentsRequest.newBuilder()
.setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListCloudControlDeploymentsResponse response =
deploymentClient.listCloudControlDeploymentsCallable().call(request);
for (CloudControlDeployment element : response.getCloudControlDeploymentsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListCloudControlDeploymentsRequest,ListCloudControlDeploymentsResponse> |
|
listCloudControlDeploymentsPagedCallable()
public final UnaryCallable<ListCloudControlDeploymentsRequest,DeploymentClient.ListCloudControlDeploymentsPagedResponse> listCloudControlDeploymentsPagedCallable()Lists the cloud conrol deployments in a given parent resource.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
ListCloudControlDeploymentsRequest request =
ListCloudControlDeploymentsRequest.newBuilder()
.setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<CloudControlDeployment> future =
deploymentClient.listCloudControlDeploymentsPagedCallable().futureCall(request);
// Do something.
for (CloudControlDeployment element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListCloudControlDeploymentsRequest,ListCloudControlDeploymentsPagedResponse> |
|
listFrameworkDeployments(ListFrameworkDeploymentsRequest request)
public final DeploymentClient.ListFrameworkDeploymentsPagedResponse listFrameworkDeployments(ListFrameworkDeploymentsRequest request)Lists the framework deployments in a given parent resource.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
ListFrameworkDeploymentsRequest request =
ListFrameworkDeploymentsRequest.newBuilder()
.setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (FrameworkDeployment element :
deploymentClient.listFrameworkDeployments(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListFrameworkDeploymentsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
DeploymentClient.ListFrameworkDeploymentsPagedResponse |
|
listFrameworkDeployments(OrganizationLocationName parent)
public final DeploymentClient.ListFrameworkDeploymentsPagedResponse listFrameworkDeployments(OrganizationLocationName parent)Lists the framework deployments in a given parent resource.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
for (FrameworkDeployment element :
deploymentClient.listFrameworkDeployments(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
OrganizationLocationNameRequired. The parent resource of the framework deployment, in the format
|
| Returns | |
|---|---|
| Type | Description |
DeploymentClient.ListFrameworkDeploymentsPagedResponse |
|
listFrameworkDeployments(String parent)
public final DeploymentClient.ListFrameworkDeploymentsPagedResponse listFrameworkDeployments(String parent)Lists the framework deployments in a given parent resource.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
for (FrameworkDeployment element :
deploymentClient.listFrameworkDeployments(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent resource of the framework deployment, in the format
|
| Returns | |
|---|---|
| Type | Description |
DeploymentClient.ListFrameworkDeploymentsPagedResponse |
|
listFrameworkDeploymentsCallable()
public final UnaryCallable<ListFrameworkDeploymentsRequest,ListFrameworkDeploymentsResponse> listFrameworkDeploymentsCallable()Lists the framework deployments in a given parent resource.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
ListFrameworkDeploymentsRequest request =
ListFrameworkDeploymentsRequest.newBuilder()
.setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListFrameworkDeploymentsResponse response =
deploymentClient.listFrameworkDeploymentsCallable().call(request);
for (FrameworkDeployment element : response.getFrameworkDeploymentsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListFrameworkDeploymentsRequest,ListFrameworkDeploymentsResponse> |
|
listFrameworkDeploymentsPagedCallable()
public final UnaryCallable<ListFrameworkDeploymentsRequest,DeploymentClient.ListFrameworkDeploymentsPagedResponse> listFrameworkDeploymentsPagedCallable()Lists the framework deployments in a given parent resource.
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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
ListFrameworkDeploymentsRequest request =
ListFrameworkDeploymentsRequest.newBuilder()
.setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<FrameworkDeployment> future =
deploymentClient.listFrameworkDeploymentsPagedCallable().futureCall(request);
// Do something.
for (FrameworkDeployment element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListFrameworkDeploymentsRequest,ListFrameworkDeploymentsPagedResponse> |
|
listLocations(ListLocationsRequest request)
public final DeploymentClient.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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : deploymentClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.cloud.location.ListLocationsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
DeploymentClient.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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = deploymentClient.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,DeploymentClient.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 (DeploymentClient deploymentClient = DeploymentClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
deploymentClient.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()