- 4.50.0 (latest)
- 4.49.0
- 4.48.0
- 4.46.0
- 4.45.0
- 4.44.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.34.0
- 4.33.0
- 4.32.0
- 4.31.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.16.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.0
- 4.8.0
- 4.6.0
- 4.5.0
- 4.4.0
- 4.3.0
- 4.2.0
- 4.1.0
- 4.0.8
- 3.1.2
- 3.0.3
- 2.3.1
public class AutoscalingPolicyServiceClient implements BackgroundResource
Service Description: The API interface for managing autoscaling policies in the Dataproc API.
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:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
AutoscalingPolicy policy = AutoscalingPolicy.newBuilder().build();
AutoscalingPolicy response =
autoscalingPolicyServiceClient.createAutoscalingPolicy(parent, policy);
}
Note: close() needs to be called on the AutoscalingPolicyServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns 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 AutoscalingPolicyServiceSettings to create(). For example:
To customize credentials:
AutoscalingPolicyServiceSettings autoscalingPolicyServiceSettings =
AutoscalingPolicyServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create(autoscalingPolicyServiceSettings);
To customize the endpoint:
AutoscalingPolicyServiceSettings autoscalingPolicyServiceSettings =
AutoscalingPolicyServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create(autoscalingPolicyServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceConstructors
AutoscalingPolicyServiceClient(AutoscalingPolicyServiceSettings settings)
protected AutoscalingPolicyServiceClient(AutoscalingPolicyServiceSettings settings)
Constructs an instance of AutoscalingPolicyServiceClient, 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.
Name | Description |
settings | AutoscalingPolicyServiceSettings |
AutoscalingPolicyServiceClient(AutoscalingPolicyServiceStub stub)
protected AutoscalingPolicyServiceClient(AutoscalingPolicyServiceStub stub)
Name | Description |
stub | AutoscalingPolicyServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
create()
public static final AutoscalingPolicyServiceClient create()
Constructs an instance of AutoscalingPolicyServiceClient with default settings.
Type | Description |
AutoscalingPolicyServiceClient |
Type | Description |
IOException |
create(AutoscalingPolicyServiceSettings settings)
public static final AutoscalingPolicyServiceClient create(AutoscalingPolicyServiceSettings settings)
Constructs an instance of AutoscalingPolicyServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Name | Description |
settings | AutoscalingPolicyServiceSettings |
Type | Description |
AutoscalingPolicyServiceClient |
Type | Description |
IOException |
create(AutoscalingPolicyServiceStub stub)
public static final AutoscalingPolicyServiceClient create(AutoscalingPolicyServiceStub stub)
Constructs an instance of AutoscalingPolicyServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AutoscalingPolicyServiceSettings).
Name | Description |
stub | AutoscalingPolicyServiceStub |
Type | Description |
AutoscalingPolicyServiceClient |
createAutoscalingPolicy(CreateAutoscalingPolicyRequest request)
public final AutoscalingPolicy createAutoscalingPolicy(CreateAutoscalingPolicyRequest request)
Creates new autoscaling policy.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
CreateAutoscalingPolicyRequest request =
CreateAutoscalingPolicyRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPolicy(AutoscalingPolicy.newBuilder().build())
.build();
AutoscalingPolicy response = autoscalingPolicyServiceClient.createAutoscalingPolicy(request);
}
Name | Description |
request | CreateAutoscalingPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
AutoscalingPolicy |
createAutoscalingPolicy(LocationName parent, AutoscalingPolicy policy)
public final AutoscalingPolicy createAutoscalingPolicy(LocationName parent, AutoscalingPolicy policy)
Creates new autoscaling policy.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
AutoscalingPolicy policy = AutoscalingPolicy.newBuilder().build();
AutoscalingPolicy response =
autoscalingPolicyServiceClient.createAutoscalingPolicy(parent, policy);
}
Name | Description |
parent | LocationName Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
policy | AutoscalingPolicy Required. The autoscaling policy to create. |
Type | Description |
AutoscalingPolicy |
createAutoscalingPolicy(RegionName parent, AutoscalingPolicy policy)
public final AutoscalingPolicy createAutoscalingPolicy(RegionName parent, AutoscalingPolicy policy)
Creates new autoscaling policy.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
AutoscalingPolicy policy = AutoscalingPolicy.newBuilder().build();
AutoscalingPolicy response =
autoscalingPolicyServiceClient.createAutoscalingPolicy(parent, policy);
}
Name | Description |
parent | RegionName Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
policy | AutoscalingPolicy Required. The autoscaling policy to create. |
Type | Description |
AutoscalingPolicy |
createAutoscalingPolicy(String parent, AutoscalingPolicy policy)
public final AutoscalingPolicy createAutoscalingPolicy(String parent, AutoscalingPolicy policy)
Creates new autoscaling policy.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
AutoscalingPolicy policy = AutoscalingPolicy.newBuilder().build();
AutoscalingPolicy response =
autoscalingPolicyServiceClient.createAutoscalingPolicy(parent, policy);
}
Name | Description |
parent | String Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
policy | AutoscalingPolicy Required. The autoscaling policy to create. |
Type | Description |
AutoscalingPolicy |
createAutoscalingPolicyCallable()
public final UnaryCallable<CreateAutoscalingPolicyRequest,AutoscalingPolicy> createAutoscalingPolicyCallable()
Creates new autoscaling policy.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
CreateAutoscalingPolicyRequest request =
CreateAutoscalingPolicyRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPolicy(AutoscalingPolicy.newBuilder().build())
.build();
ApiFuture
Type | Description |
UnaryCallable<CreateAutoscalingPolicyRequest,AutoscalingPolicy> |
deleteAutoscalingPolicy(AutoscalingPolicyName name)
public final void deleteAutoscalingPolicy(AutoscalingPolicyName name)
Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
AutoscalingPolicyName name =
AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
"[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]");
autoscalingPolicyServiceClient.deleteAutoscalingPolicy(name);
}
Name | Description |
name | AutoscalingPolicyName Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
|
deleteAutoscalingPolicy(DeleteAutoscalingPolicyRequest request)
public final void deleteAutoscalingPolicy(DeleteAutoscalingPolicyRequest request)
Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
DeleteAutoscalingPolicyRequest request =
DeleteAutoscalingPolicyRequest.newBuilder()
.setName(
AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
"[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]")
.toString())
.build();
autoscalingPolicyServiceClient.deleteAutoscalingPolicy(request);
}
Name | Description |
request | DeleteAutoscalingPolicyRequest The request object containing all of the parameters for the API call. |
deleteAutoscalingPolicy(String name)
public final void deleteAutoscalingPolicy(String name)
Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
String name =
AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
"[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]")
.toString();
autoscalingPolicyServiceClient.deleteAutoscalingPolicy(name);
}
Name | Description |
name | String Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
|
deleteAutoscalingPolicyCallable()
public final UnaryCallable<DeleteAutoscalingPolicyRequest,Empty> deleteAutoscalingPolicyCallable()
Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
DeleteAutoscalingPolicyRequest request =
DeleteAutoscalingPolicyRequest.newBuilder()
.setName(
AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
"[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]")
.toString())
.build();
ApiFuture<Empty> future =
autoscalingPolicyServiceClient.deleteAutoscalingPolicyCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteAutoscalingPolicyRequest,Empty> |
getAutoscalingPolicy(AutoscalingPolicyName name)
public final AutoscalingPolicy getAutoscalingPolicy(AutoscalingPolicyName name)
Retrieves autoscaling policy.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
AutoscalingPolicyName name =
AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
"[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]");
AutoscalingPolicy response = autoscalingPolicyServiceClient.getAutoscalingPolicy(name);
}
Name | Description |
name | AutoscalingPolicyName Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
|
Type | Description |
AutoscalingPolicy |
getAutoscalingPolicy(GetAutoscalingPolicyRequest request)
public final AutoscalingPolicy getAutoscalingPolicy(GetAutoscalingPolicyRequest request)
Retrieves autoscaling policy.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
GetAutoscalingPolicyRequest request =
GetAutoscalingPolicyRequest.newBuilder()
.setName(
AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
"[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]")
.toString())
.build();
AutoscalingPolicy response = autoscalingPolicyServiceClient.getAutoscalingPolicy(request);
}
Name | Description |
request | GetAutoscalingPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
AutoscalingPolicy |
getAutoscalingPolicy(String name)
public final AutoscalingPolicy getAutoscalingPolicy(String name)
Retrieves autoscaling policy.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
String name =
AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
"[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]")
.toString();
AutoscalingPolicy response = autoscalingPolicyServiceClient.getAutoscalingPolicy(name);
}
Name | Description |
name | String Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
|
Type | Description |
AutoscalingPolicy |
getAutoscalingPolicyCallable()
public final UnaryCallable<GetAutoscalingPolicyRequest,AutoscalingPolicy> getAutoscalingPolicyCallable()
Retrieves autoscaling policy.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
GetAutoscalingPolicyRequest request =
GetAutoscalingPolicyRequest.newBuilder()
.setName(
AutoscalingPolicyName.ofProjectLocationAutoscalingPolicyName(
"[PROJECT]", "[LOCATION]", "[AUTOSCALING_POLICY]")
.toString())
.build();
ApiFuture
Type | Description |
UnaryCallable<GetAutoscalingPolicyRequest,AutoscalingPolicy> |
getSettings()
public final AutoscalingPolicyServiceSettings getSettings()
Type | Description |
AutoscalingPolicyServiceSettings |
getStub()
public AutoscalingPolicyServiceStub getStub()
Type | Description |
AutoscalingPolicyServiceStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listAutoscalingPolicies(ListAutoscalingPoliciesRequest request)
public final AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse listAutoscalingPolicies(ListAutoscalingPoliciesRequest request)
Lists autoscaling policies in the project.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
ListAutoscalingPoliciesRequest request =
ListAutoscalingPoliciesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (AutoscalingPolicy element :
autoscalingPolicyServiceClient.listAutoscalingPolicies(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListAutoscalingPoliciesRequest The request object containing all of the parameters for the API call. |
Type | Description |
AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse |
listAutoscalingPolicies(LocationName parent)
public final AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse listAutoscalingPolicies(LocationName parent)
Lists autoscaling policies in the project.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (AutoscalingPolicy element :
autoscalingPolicyServiceClient.listAutoscalingPolicies(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
Type | Description |
AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse |
listAutoscalingPolicies(RegionName parent)
public final AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse listAutoscalingPolicies(RegionName parent)
Lists autoscaling policies in the project.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
RegionName parent = RegionName.of("[PROJECT]", "[REGION]");
for (AutoscalingPolicy element :
autoscalingPolicyServiceClient.listAutoscalingPolicies(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | RegionName Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
Type | Description |
AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse |
listAutoscalingPolicies(String parent)
public final AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse listAutoscalingPolicies(String parent)
Lists autoscaling policies in the project.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (AutoscalingPolicy element :
autoscalingPolicyServiceClient.listAutoscalingPolicies(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
|
Type | Description |
AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse |
listAutoscalingPoliciesCallable()
public final UnaryCallable<ListAutoscalingPoliciesRequest,ListAutoscalingPoliciesResponse> listAutoscalingPoliciesCallable()
Lists autoscaling policies in the project.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
ListAutoscalingPoliciesRequest request =
ListAutoscalingPoliciesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListAutoscalingPoliciesResponse response =
autoscalingPolicyServiceClient.listAutoscalingPoliciesCallable().call(request);
for (AutoscalingPolicy element : response.getResponsesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListAutoscalingPoliciesRequest,ListAutoscalingPoliciesResponse> |
listAutoscalingPoliciesPagedCallable()
public final UnaryCallable<ListAutoscalingPoliciesRequest,AutoscalingPolicyServiceClient.ListAutoscalingPoliciesPagedResponse> listAutoscalingPoliciesPagedCallable()
Lists autoscaling policies in the project.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
ListAutoscalingPoliciesRequest request =
ListAutoscalingPoliciesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture
Type | Description |
UnaryCallable<ListAutoscalingPoliciesRequest,ListAutoscalingPoliciesPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateAutoscalingPolicy(AutoscalingPolicy policy)
public final AutoscalingPolicy updateAutoscalingPolicy(AutoscalingPolicy policy)
Updates (replaces) autoscaling policy.
Disabled check for update_mask, because all updates will be full replacements.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
AutoscalingPolicy policy = AutoscalingPolicy.newBuilder().build();
AutoscalingPolicy response = autoscalingPolicyServiceClient.updateAutoscalingPolicy(policy);
}
Name | Description |
policy | AutoscalingPolicy Required. The updated autoscaling policy. |
Type | Description |
AutoscalingPolicy |
updateAutoscalingPolicy(UpdateAutoscalingPolicyRequest request)
public final AutoscalingPolicy updateAutoscalingPolicy(UpdateAutoscalingPolicyRequest request)
Updates (replaces) autoscaling policy.
Disabled check for update_mask, because all updates will be full replacements.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
UpdateAutoscalingPolicyRequest request =
UpdateAutoscalingPolicyRequest.newBuilder()
.setPolicy(AutoscalingPolicy.newBuilder().build())
.build();
AutoscalingPolicy response = autoscalingPolicyServiceClient.updateAutoscalingPolicy(request);
}
Name | Description |
request | UpdateAutoscalingPolicyRequest The request object containing all of the parameters for the API call. |
Type | Description |
AutoscalingPolicy |
updateAutoscalingPolicyCallable()
public final UnaryCallable<UpdateAutoscalingPolicyRequest,AutoscalingPolicy> updateAutoscalingPolicyCallable()
Updates (replaces) autoscaling policy.
Disabled check for update_mask, because all updates will be full replacements.
Sample code:
try (AutoscalingPolicyServiceClient autoscalingPolicyServiceClient =
AutoscalingPolicyServiceClient.create()) {
UpdateAutoscalingPolicyRequest request =
UpdateAutoscalingPolicyRequest.newBuilder()
.setPolicy(AutoscalingPolicy.newBuilder().build())
.build();
ApiFuture
Type | Description |
UnaryCallable<UpdateAutoscalingPolicyRequest,AutoscalingPolicy> |