Package com.google.cloud.visionai.v1
Class AppPlatformSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<AppPlatformSettings>
com.google.cloud.visionai.v1.AppPlatformSettings
@Generated("by gapic-generator-java")
public class AppPlatformSettings
extends ClientSettings<AppPlatformSettings>
Settings class to configure an instance of
AppPlatformClient.
The default instance has everything set to sensible defaults:
- The default service address (visionai.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
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://docs.cloud.google.com/java/docs/client-retries) 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();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for AppPlatformSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAppPlatformSettings(AppPlatformSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionOperationCallSettings<AddApplicationStreamInputRequest,AddApplicationStreamInputResponse, OperationMetadata> Returns the object with the settings used for calls to addApplicationStreamInput.Returns the object with the settings used for calls to addApplicationStreamInput.static final AppPlatformSettingsOperationCallSettings<CreateApplicationInstancesRequest,CreateApplicationInstancesResponse, OperationMetadata> Returns the object with the settings used for calls to createApplicationInstances.Returns the object with the settings used for calls to createApplicationInstances.Returns the object with the settings used for calls to createApplication.Returns the object with the settings used for calls to createApplication.Returns the object with the settings used for calls to createDraft.Returns the object with the settings used for calls to createDraft.Returns the object with the settings used for calls to createProcessor.Returns the object with the settings used for calls to createProcessor.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderReturns the object with the settings used for calls to deleteApplicationInstances.Returns the object with the settings used for calls to deleteApplicationInstances.OperationCallSettings<DeleteApplicationRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteApplication.Returns the object with the settings used for calls to deleteApplication.OperationCallSettings<DeleteDraftRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteDraft.Returns the object with the settings used for calls to deleteDraft.OperationCallSettings<DeleteProcessorRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteProcessor.Returns the object with the settings used for calls to deleteProcessor.Returns the object with the settings used for calls to deployApplication.Returns the object with the settings used for calls to deployApplication.Returns the object with the settings used for calls to getApplication.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getDraft.Returns the object with the settings used for calls to getInstance.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getProcessor.PagedCallSettings<ListApplicationsRequest,ListApplicationsResponse, AppPlatformClient.ListApplicationsPagedResponse> Returns the object with the settings used for calls to listApplications.Returns the object with the settings used for calls to listDrafts.PagedCallSettings<ListInstancesRequest,ListInstancesResponse, AppPlatformClient.ListInstancesPagedResponse> Returns the object with the settings used for calls to listInstances.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, AppPlatformClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns the object with the settings used for calls to listPrebuiltProcessors.PagedCallSettings<ListProcessorsRequest,ListProcessorsResponse, AppPlatformClient.ListProcessorsPagedResponse> Returns the object with the settings used for calls to listProcessors.static AppPlatformSettings.BuilderReturns a new gRPC builder for this class.static AppPlatformSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static AppPlatformSettings.BuilderReturns a new REST builder for this class.OperationCallSettings<RemoveApplicationStreamInputRequest,RemoveApplicationStreamInputResponse, OperationMetadata> Returns the object with the settings used for calls to removeApplicationStreamInput.Returns the object with the settings used for calls to removeApplicationStreamInput.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to undeployApplication.Returns the object with the settings used for calls to undeployApplication.OperationCallSettings<UpdateApplicationInstancesRequest,UpdateApplicationInstancesResponse, OperationMetadata> Returns the object with the settings used for calls to updateApplicationInstances.Returns the object with the settings used for calls to updateApplicationInstances.Returns the object with the settings used for calls to updateApplication.Returns the object with the settings used for calls to updateApplication.OperationCallSettings<UpdateApplicationStreamInputRequest,UpdateApplicationStreamInputResponse, OperationMetadata> Returns the object with the settings used for calls to updateApplicationStreamInput.Returns the object with the settings used for calls to updateApplicationStreamInput.Returns the object with the settings used for calls to updateDraft.Returns the object with the settings used for calls to updateDraft.Returns the object with the settings used for calls to updateProcessor.Returns the object with the settings used for calls to updateProcessor.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
AppPlatformSettings
- Throws:
IOException
-
-
Method Details
-
listApplicationsSettings
public PagedCallSettings<ListApplicationsRequest,ListApplicationsResponse, listApplicationsSettings()AppPlatformClient.ListApplicationsPagedResponse> Returns the object with the settings used for calls to listApplications. -
getApplicationSettings
Returns the object with the settings used for calls to getApplication. -
createApplicationSettings
Returns the object with the settings used for calls to createApplication. -
createApplicationOperationSettings
public OperationCallSettings<CreateApplicationRequest,Application, createApplicationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createApplication. -
updateApplicationSettings
Returns the object with the settings used for calls to updateApplication. -
updateApplicationOperationSettings
public OperationCallSettings<UpdateApplicationRequest,Application, updateApplicationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateApplication. -
deleteApplicationSettings
Returns the object with the settings used for calls to deleteApplication. -
deleteApplicationOperationSettings
public OperationCallSettings<DeleteApplicationRequest,com.google.protobuf.Empty, deleteApplicationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteApplication. -
deployApplicationSettings
Returns the object with the settings used for calls to deployApplication. -
deployApplicationOperationSettings
public OperationCallSettings<DeployApplicationRequest,DeployApplicationResponse, deployApplicationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deployApplication. -
undeployApplicationSettings
Returns the object with the settings used for calls to undeployApplication. -
undeployApplicationOperationSettings
public OperationCallSettings<UndeployApplicationRequest,UndeployApplicationResponse, undeployApplicationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to undeployApplication. -
addApplicationStreamInputSettings
public UnaryCallSettings<AddApplicationStreamInputRequest,Operation> addApplicationStreamInputSettings()Returns the object with the settings used for calls to addApplicationStreamInput. -
addApplicationStreamInputOperationSettings
public OperationCallSettings<AddApplicationStreamInputRequest,AddApplicationStreamInputResponse, addApplicationStreamInputOperationSettings()OperationMetadata> Returns the object with the settings used for calls to addApplicationStreamInput. -
removeApplicationStreamInputSettings
public UnaryCallSettings<RemoveApplicationStreamInputRequest,Operation> removeApplicationStreamInputSettings()Returns the object with the settings used for calls to removeApplicationStreamInput. -
removeApplicationStreamInputOperationSettings
public OperationCallSettings<RemoveApplicationStreamInputRequest,RemoveApplicationStreamInputResponse, removeApplicationStreamInputOperationSettings()OperationMetadata> Returns the object with the settings used for calls to removeApplicationStreamInput. -
updateApplicationStreamInputSettings
public UnaryCallSettings<UpdateApplicationStreamInputRequest,Operation> updateApplicationStreamInputSettings()Returns the object with the settings used for calls to updateApplicationStreamInput. -
updateApplicationStreamInputOperationSettings
public OperationCallSettings<UpdateApplicationStreamInputRequest,UpdateApplicationStreamInputResponse, updateApplicationStreamInputOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateApplicationStreamInput. -
listInstancesSettings
public PagedCallSettings<ListInstancesRequest,ListInstancesResponse, listInstancesSettings()AppPlatformClient.ListInstancesPagedResponse> Returns the object with the settings used for calls to listInstances. -
getInstanceSettings
Returns the object with the settings used for calls to getInstance. -
createApplicationInstancesSettings
public UnaryCallSettings<CreateApplicationInstancesRequest,Operation> createApplicationInstancesSettings()Returns the object with the settings used for calls to createApplicationInstances. -
createApplicationInstancesOperationSettings
public OperationCallSettings<CreateApplicationInstancesRequest,CreateApplicationInstancesResponse, createApplicationInstancesOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createApplicationInstances. -
deleteApplicationInstancesSettings
public UnaryCallSettings<DeleteApplicationInstancesRequest,Operation> deleteApplicationInstancesSettings()Returns the object with the settings used for calls to deleteApplicationInstances. -
deleteApplicationInstancesOperationSettings
public OperationCallSettings<DeleteApplicationInstancesRequest,Instance, deleteApplicationInstancesOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteApplicationInstances. -
updateApplicationInstancesSettings
public UnaryCallSettings<UpdateApplicationInstancesRequest,Operation> updateApplicationInstancesSettings()Returns the object with the settings used for calls to updateApplicationInstances. -
updateApplicationInstancesOperationSettings
public OperationCallSettings<UpdateApplicationInstancesRequest,UpdateApplicationInstancesResponse, updateApplicationInstancesOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateApplicationInstances. -
listDraftsSettings
public PagedCallSettings<ListDraftsRequest,ListDraftsResponse, listDraftsSettings()AppPlatformClient.ListDraftsPagedResponse> Returns the object with the settings used for calls to listDrafts. -
getDraftSettings
Returns the object with the settings used for calls to getDraft. -
createDraftSettings
Returns the object with the settings used for calls to createDraft. -
createDraftOperationSettings
public OperationCallSettings<CreateDraftRequest,Draft, createDraftOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createDraft. -
updateDraftSettings
Returns the object with the settings used for calls to updateDraft. -
updateDraftOperationSettings
public OperationCallSettings<UpdateDraftRequest,Draft, updateDraftOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateDraft. -
deleteDraftSettings
Returns the object with the settings used for calls to deleteDraft. -
deleteDraftOperationSettings
public OperationCallSettings<DeleteDraftRequest,com.google.protobuf.Empty, deleteDraftOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteDraft. -
listProcessorsSettings
public PagedCallSettings<ListProcessorsRequest,ListProcessorsResponse, listProcessorsSettings()AppPlatformClient.ListProcessorsPagedResponse> Returns the object with the settings used for calls to listProcessors. -
listPrebuiltProcessorsSettings
public UnaryCallSettings<ListPrebuiltProcessorsRequest,ListPrebuiltProcessorsResponse> listPrebuiltProcessorsSettings()Returns the object with the settings used for calls to listPrebuiltProcessors. -
getProcessorSettings
Returns the object with the settings used for calls to getProcessor. -
createProcessorSettings
Returns the object with the settings used for calls to createProcessor. -
createProcessorOperationSettings
public OperationCallSettings<CreateProcessorRequest,Processor, createProcessorOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createProcessor. -
updateProcessorSettings
Returns the object with the settings used for calls to updateProcessor. -
updateProcessorOperationSettings
public OperationCallSettings<UpdateProcessorRequest,Processor, updateProcessorOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateProcessor. -
deleteProcessorSettings
Returns the object with the settings used for calls to deleteProcessor. -
deleteProcessorOperationSettings
public OperationCallSettings<DeleteProcessorRequest,com.google.protobuf.Empty, deleteProcessorOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteProcessor. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()AppPlatformClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<AppPlatformSettings>
-