@Generated(value="by gapic-generator-java") public class AppPlatformSettings extends com.google.api.gax.rpc.ClientSettings<AppPlatformSettings>
AppPlatformClient.
The default instance has everything set to sensible defaults:
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getApplication:
// 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
AppPlatformSettings.Builder appPlatformSettingsBuilder = AppPlatformSettings.newBuilder();
appPlatformSettingsBuilder
.getApplicationSettings()
.setRetrySettings(
appPlatformSettingsBuilder
.getApplicationSettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
AppPlatformSettings appPlatformSettings = appPlatformSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for
additional support in setting retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createApplication:
// 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
AppPlatformSettings.Builder appPlatformSettingsBuilder = AppPlatformSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
appPlatformSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
AppPlatformSettings.Builder
Builder for AppPlatformSettings.
|
| Modifier | Constructor and Description |
|---|---|
protected |
AppPlatformSettings(AppPlatformSettings.Builder settingsBuilder) |
| Modifier and Type | Method and Description |
|---|---|
com.google.api.gax.rpc.OperationCallSettings<AddApplicationStreamInputRequest,AddApplicationStreamInputResponse,OperationMetadata> |
addApplicationStreamInputOperationSettings()
Returns the object with the settings used for calls to addApplicationStreamInput.
|
com.google.api.gax.rpc.UnaryCallSettings<AddApplicationStreamInputRequest,com.google.longrunning.Operation> |
addApplicationStreamInputSettings()
Returns the object with the settings used for calls to addApplicationStreamInput.
|
static AppPlatformSettings |
create(AppPlatformStubSettings stub) |
com.google.api.gax.rpc.OperationCallSettings<CreateApplicationInstancesRequest,CreateApplicationInstancesResponse,OperationMetadata> |
createApplicationInstancesOperationSettings()
Returns the object with the settings used for calls to createApplicationInstances.
|
com.google.api.gax.rpc.UnaryCallSettings<CreateApplicationInstancesRequest,com.google.longrunning.Operation> |
createApplicationInstancesSettings()
Returns the object with the settings used for calls to createApplicationInstances.
|
com.google.api.gax.rpc.OperationCallSettings<CreateApplicationRequest,Application,OperationMetadata> |
createApplicationOperationSettings()
Returns the object with the settings used for calls to createApplication.
|
com.google.api.gax.rpc.UnaryCallSettings<CreateApplicationRequest,com.google.longrunning.Operation> |
createApplicationSettings()
Returns the object with the settings used for calls to createApplication.
|
com.google.api.gax.rpc.OperationCallSettings<CreateDraftRequest,Draft,OperationMetadata> |
createDraftOperationSettings()
Returns the object with the settings used for calls to createDraft.
|
com.google.api.gax.rpc.UnaryCallSettings<CreateDraftRequest,com.google.longrunning.Operation> |
createDraftSettings()
Returns the object with the settings used for calls to createDraft.
|
com.google.api.gax.rpc.OperationCallSettings<CreateProcessorRequest,Processor,OperationMetadata> |
createProcessorOperationSettings()
Returns the object with the settings used for calls to createProcessor.
|
com.google.api.gax.rpc.UnaryCallSettings<CreateProcessorRequest,com.google.longrunning.Operation> |
createProcessorSettings()
Returns the object with the settings used for calls to createProcessor.
|
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder |
defaultApiClientHeaderProviderBuilder() |
static com.google.api.gax.core.GoogleCredentialsProvider.Builder |
defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
|
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder |
defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
|
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder |
defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
|
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder |
defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
|
static com.google.api.gax.rpc.TransportChannelProvider |
defaultTransportChannelProvider() |
com.google.api.gax.rpc.OperationCallSettings<DeleteApplicationInstancesRequest,Instance,OperationMetadata> |
deleteApplicationInstancesOperationSettings()
Returns the object with the settings used for calls to deleteApplicationInstances.
|
com.google.api.gax.rpc.UnaryCallSettings<DeleteApplicationInstancesRequest,com.google.longrunning.Operation> |
deleteApplicationInstancesSettings()
Returns the object with the settings used for calls to deleteApplicationInstances.
|
com.google.api.gax.rpc.OperationCallSettings<DeleteApplicationRequest,com.google.protobuf.Empty,OperationMetadata> |
deleteApplicationOperationSettings()
Returns the object with the settings used for calls to deleteApplication.
|
com.google.api.gax.rpc.UnaryCallSettings<DeleteApplicationRequest,com.google.longrunning.Operation> |
deleteApplicationSettings()
Returns the object with the settings used for calls to deleteApplication.
|
com.google.api.gax.rpc.OperationCallSettings<DeleteDraftRequest,com.google.protobuf.Empty,OperationMetadata> |
deleteDraftOperationSettings()
Returns the object with the settings used for calls to deleteDraft.
|
com.google.api.gax.rpc.UnaryCallSettings<DeleteDraftRequest,com.google.longrunning.Operation> |
deleteDraftSettings()
Returns the object with the settings used for calls to deleteDraft.
|
com.google.api.gax.rpc.OperationCallSettings<DeleteProcessorRequest,com.google.protobuf.Empty,OperationMetadata> |
deleteProcessorOperationSettings()
Returns the object with the settings used for calls to deleteProcessor.
|
com.google.api.gax.rpc.UnaryCallSettings<DeleteProcessorRequest,com.google.longrunning.Operation> |
deleteProcessorSettings()
Returns the object with the settings used for calls to deleteProcessor.
|
com.google.api.gax.rpc.OperationCallSettings<DeployApplicationRequest,DeployApplicationResponse,OperationMetadata> |
deployApplicationOperationSettings()
Returns the object with the settings used for calls to deployApplication.
|
com.google.api.gax.rpc.UnaryCallSettings<DeployApplicationRequest,com.google.longrunning.Operation> |
deployApplicationSettings()
Returns the object with the settings used for calls to deployApplication.
|
com.google.api.gax.rpc.UnaryCallSettings<GetApplicationRequest,Application> |
getApplicationSettings()
Returns the object with the settings used for calls to getApplication.
|
static String |
getDefaultEndpoint()
Returns the default service endpoint.
|
static List<String> |
getDefaultServiceScopes()
Returns the default service scopes.
|
com.google.api.gax.rpc.UnaryCallSettings<GetDraftRequest,Draft> |
getDraftSettings()
Returns the object with the settings used for calls to getDraft.
|
com.google.api.gax.rpc.UnaryCallSettings<GetInstanceRequest,Instance> |
getInstanceSettings()
Returns the object with the settings used for calls to getInstance.
|
com.google.api.gax.rpc.UnaryCallSettings<GetProcessorRequest,Processor> |
getProcessorSettings()
Returns the object with the settings used for calls to getProcessor.
|
com.google.api.gax.rpc.PagedCallSettings<ListApplicationsRequest,ListApplicationsResponse,AppPlatformClient.ListApplicationsPagedResponse> |
listApplicationsSettings()
Returns the object with the settings used for calls to listApplications.
|
com.google.api.gax.rpc.PagedCallSettings<ListDraftsRequest,ListDraftsResponse,AppPlatformClient.ListDraftsPagedResponse> |
listDraftsSettings()
Returns the object with the settings used for calls to listDrafts.
|
com.google.api.gax.rpc.PagedCallSettings<ListInstancesRequest,ListInstancesResponse,AppPlatformClient.ListInstancesPagedResponse> |
listInstancesSettings()
Returns the object with the settings used for calls to listInstances.
|
com.google.api.gax.rpc.UnaryCallSettings<ListPrebuiltProcessorsRequest,ListPrebuiltProcessorsResponse> |
listPrebuiltProcessorsSettings()
Returns the object with the settings used for calls to listPrebuiltProcessors.
|
com.google.api.gax.rpc.PagedCallSettings<ListProcessorsRequest,ListProcessorsResponse,AppPlatformClient.ListProcessorsPagedResponse> |
listProcessorsSettings()
Returns the object with the settings used for calls to listProcessors.
|
static AppPlatformSettings.Builder |
newBuilder()
Returns a new gRPC builder for this class.
|
static AppPlatformSettings.Builder |
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
|
static AppPlatformSettings.Builder |
newHttpJsonBuilder()
Returns a new REST builder for this class.
|
com.google.api.gax.rpc.OperationCallSettings<RemoveApplicationStreamInputRequest,RemoveApplicationStreamInputResponse,OperationMetadata> |
removeApplicationStreamInputOperationSettings()
Returns the object with the settings used for calls to removeApplicationStreamInput.
|
com.google.api.gax.rpc.UnaryCallSettings<RemoveApplicationStreamInputRequest,com.google.longrunning.Operation> |
removeApplicationStreamInputSettings()
Returns the object with the settings used for calls to removeApplicationStreamInput.
|
AppPlatformSettings.Builder |
toBuilder()
Returns a builder containing all the values of this settings class.
|
com.google.api.gax.rpc.OperationCallSettings<UndeployApplicationRequest,UndeployApplicationResponse,OperationMetadata> |
undeployApplicationOperationSettings()
Returns the object with the settings used for calls to undeployApplication.
|
com.google.api.gax.rpc.UnaryCallSettings<UndeployApplicationRequest,com.google.longrunning.Operation> |
undeployApplicationSettings()
Returns the object with the settings used for calls to undeployApplication.
|
com.google.api.gax.rpc.OperationCallSettings<UpdateApplicationInstancesRequest,UpdateApplicationInstancesResponse,OperationMetadata> |
updateApplicationInstancesOperationSettings()
Returns the object with the settings used for calls to updateApplicationInstances.
|
com.google.api.gax.rpc.UnaryCallSettings<UpdateApplicationInstancesRequest,com.google.longrunning.Operation> |
updateApplicationInstancesSettings()
Returns the object with the settings used for calls to updateApplicationInstances.
|
com.google.api.gax.rpc.OperationCallSettings<UpdateApplicationRequest,Application,OperationMetadata> |
updateApplicationOperationSettings()
Returns the object with the settings used for calls to updateApplication.
|
com.google.api.gax.rpc.UnaryCallSettings<UpdateApplicationRequest,com.google.longrunning.Operation> |
updateApplicationSettings()
Returns the object with the settings used for calls to updateApplication.
|
com.google.api.gax.rpc.OperationCallSettings<UpdateApplicationStreamInputRequest,UpdateApplicationStreamInputResponse,OperationMetadata> |
updateApplicationStreamInputOperationSettings()
Returns the object with the settings used for calls to updateApplicationStreamInput.
|
com.google.api.gax.rpc.UnaryCallSettings<UpdateApplicationStreamInputRequest,com.google.longrunning.Operation> |
updateApplicationStreamInputSettings()
Returns the object with the settings used for calls to updateApplicationStreamInput.
|
com.google.api.gax.rpc.OperationCallSettings<UpdateDraftRequest,Draft,OperationMetadata> |
updateDraftOperationSettings()
Returns the object with the settings used for calls to updateDraft.
|
com.google.api.gax.rpc.UnaryCallSettings<UpdateDraftRequest,com.google.longrunning.Operation> |
updateDraftSettings()
Returns the object with the settings used for calls to updateDraft.
|
com.google.api.gax.rpc.OperationCallSettings<UpdateProcessorRequest,Processor,OperationMetadata> |
updateProcessorOperationSettings()
Returns the object with the settings used for calls to updateProcessor.
|
com.google.api.gax.rpc.UnaryCallSettings<UpdateProcessorRequest,com.google.longrunning.Operation> |
updateProcessorSettings()
Returns the object with the settings used for calls to updateProcessor.
|
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toStringprotected AppPlatformSettings(AppPlatformSettings.Builder settingsBuilder) throws IOException
IOExceptionpublic com.google.api.gax.rpc.PagedCallSettings<ListApplicationsRequest,ListApplicationsResponse,AppPlatformClient.ListApplicationsPagedResponse> listApplicationsSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GetApplicationRequest,Application> getApplicationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<CreateApplicationRequest,com.google.longrunning.Operation> createApplicationSettings()
public com.google.api.gax.rpc.OperationCallSettings<CreateApplicationRequest,Application,OperationMetadata> createApplicationOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<UpdateApplicationRequest,com.google.longrunning.Operation> updateApplicationSettings()
public com.google.api.gax.rpc.OperationCallSettings<UpdateApplicationRequest,Application,OperationMetadata> updateApplicationOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeleteApplicationRequest,com.google.longrunning.Operation> deleteApplicationSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeleteApplicationRequest,com.google.protobuf.Empty,OperationMetadata> deleteApplicationOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeployApplicationRequest,com.google.longrunning.Operation> deployApplicationSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeployApplicationRequest,DeployApplicationResponse,OperationMetadata> deployApplicationOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<UndeployApplicationRequest,com.google.longrunning.Operation> undeployApplicationSettings()
public com.google.api.gax.rpc.OperationCallSettings<UndeployApplicationRequest,UndeployApplicationResponse,OperationMetadata> undeployApplicationOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<AddApplicationStreamInputRequest,com.google.longrunning.Operation> addApplicationStreamInputSettings()
public com.google.api.gax.rpc.OperationCallSettings<AddApplicationStreamInputRequest,AddApplicationStreamInputResponse,OperationMetadata> addApplicationStreamInputOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<RemoveApplicationStreamInputRequest,com.google.longrunning.Operation> removeApplicationStreamInputSettings()
public com.google.api.gax.rpc.OperationCallSettings<RemoveApplicationStreamInputRequest,RemoveApplicationStreamInputResponse,OperationMetadata> removeApplicationStreamInputOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<UpdateApplicationStreamInputRequest,com.google.longrunning.Operation> updateApplicationStreamInputSettings()
public com.google.api.gax.rpc.OperationCallSettings<UpdateApplicationStreamInputRequest,UpdateApplicationStreamInputResponse,OperationMetadata> updateApplicationStreamInputOperationSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListInstancesRequest,ListInstancesResponse,AppPlatformClient.ListInstancesPagedResponse> listInstancesSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()
public com.google.api.gax.rpc.UnaryCallSettings<CreateApplicationInstancesRequest,com.google.longrunning.Operation> createApplicationInstancesSettings()
public com.google.api.gax.rpc.OperationCallSettings<CreateApplicationInstancesRequest,CreateApplicationInstancesResponse,OperationMetadata> createApplicationInstancesOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeleteApplicationInstancesRequest,com.google.longrunning.Operation> deleteApplicationInstancesSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeleteApplicationInstancesRequest,Instance,OperationMetadata> deleteApplicationInstancesOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<UpdateApplicationInstancesRequest,com.google.longrunning.Operation> updateApplicationInstancesSettings()
public com.google.api.gax.rpc.OperationCallSettings<UpdateApplicationInstancesRequest,UpdateApplicationInstancesResponse,OperationMetadata> updateApplicationInstancesOperationSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListDraftsRequest,ListDraftsResponse,AppPlatformClient.ListDraftsPagedResponse> listDraftsSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GetDraftRequest,Draft> getDraftSettings()
public com.google.api.gax.rpc.UnaryCallSettings<CreateDraftRequest,com.google.longrunning.Operation> createDraftSettings()
public com.google.api.gax.rpc.OperationCallSettings<CreateDraftRequest,Draft,OperationMetadata> createDraftOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<UpdateDraftRequest,com.google.longrunning.Operation> updateDraftSettings()
public com.google.api.gax.rpc.OperationCallSettings<UpdateDraftRequest,Draft,OperationMetadata> updateDraftOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeleteDraftRequest,com.google.longrunning.Operation> deleteDraftSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeleteDraftRequest,com.google.protobuf.Empty,OperationMetadata> deleteDraftOperationSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListProcessorsRequest,ListProcessorsResponse,AppPlatformClient.ListProcessorsPagedResponse> listProcessorsSettings()
public com.google.api.gax.rpc.UnaryCallSettings<ListPrebuiltProcessorsRequest,ListPrebuiltProcessorsResponse> listPrebuiltProcessorsSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GetProcessorRequest,Processor> getProcessorSettings()
public com.google.api.gax.rpc.UnaryCallSettings<CreateProcessorRequest,com.google.longrunning.Operation> createProcessorSettings()
public com.google.api.gax.rpc.OperationCallSettings<CreateProcessorRequest,Processor,OperationMetadata> createProcessorOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<UpdateProcessorRequest,com.google.longrunning.Operation> updateProcessorSettings()
public com.google.api.gax.rpc.OperationCallSettings<UpdateProcessorRequest,Processor,OperationMetadata> updateProcessorOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeleteProcessorRequest,com.google.longrunning.Operation> deleteProcessorSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeleteProcessorRequest,com.google.protobuf.Empty,OperationMetadata> deleteProcessorOperationSettings()
public static final AppPlatformSettings create(AppPlatformStubSettings stub) throws IOException
IOExceptionpublic static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
public static String getDefaultEndpoint()
public static List<String> getDefaultServiceScopes()
public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
@BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
public static AppPlatformSettings.Builder newBuilder()
public static AppPlatformSettings.Builder newHttpJsonBuilder()
public static AppPlatformSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
public AppPlatformSettings.Builder toBuilder()
toBuilder in class com.google.api.gax.rpc.ClientSettings<AppPlatformSettings>Copyright © 2025 Google LLC. All rights reserved.