Class AppPlatformSettings (0.12.0)

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 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 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();

Inheritance

java.lang.Object > ClientSettings > AppPlatformSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(AppPlatformStubSettings stub)

public static final AppPlatformSettings create(AppPlatformStubSettings stub)

Parameter
Name	Description
`stub`	`AppPlatformStubSettings`

Returns
Type	Description
`AppPlatformSettings`

Exceptions
Type	Description
`IOException`

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
`Builder`

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
`Builder`

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type	Description
`Builder`

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type	Description
`Builder`

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
`TransportChannelProvider`

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
`String`

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
`List<String>`

newBuilder()

public static AppPlatformSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
`AppPlatformSettings.Builder`

newBuilder(ClientContext clientContext)

public static AppPlatformSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`AppPlatformSettings.Builder`

newHttpJsonBuilder()

public static AppPlatformSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`AppPlatformSettings.Builder`

Constructors

AppPlatformSettings(AppPlatformSettings.Builder settingsBuilder)

protected AppPlatformSettings(AppPlatformSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`AppPlatformSettings.Builder`

Methods

addApplicationStreamInputOperationSettings()

public OperationCallSettings<AddApplicationStreamInputRequest,AddApplicationStreamInputResponse,OperationMetadata> addApplicationStreamInputOperationSettings()

Returns the object with the settings used for calls to addApplicationStreamInput.

Returns
Type	Description
`OperationCallSettings<AddApplicationStreamInputRequest,AddApplicationStreamInputResponse,OperationMetadata>`

addApplicationStreamInputSettings()

public UnaryCallSettings<AddApplicationStreamInputRequest,Operation> addApplicationStreamInputSettings()

Returns the object with the settings used for calls to addApplicationStreamInput.

Returns
Type	Description
`UnaryCallSettings<AddApplicationStreamInputRequest,Operation>`

createApplicationInstancesOperationSettings()

public OperationCallSettings<CreateApplicationInstancesRequest,CreateApplicationInstancesResponse,OperationMetadata> createApplicationInstancesOperationSettings()

Returns the object with the settings used for calls to createApplicationInstances.

Returns
Type	Description
`OperationCallSettings<CreateApplicationInstancesRequest,CreateApplicationInstancesResponse,OperationMetadata>`

createApplicationInstancesSettings()

public UnaryCallSettings<CreateApplicationInstancesRequest,Operation> createApplicationInstancesSettings()

Returns the object with the settings used for calls to createApplicationInstances.

Returns
Type	Description
`UnaryCallSettings<CreateApplicationInstancesRequest,Operation>`

createApplicationOperationSettings()

public OperationCallSettings<CreateApplicationRequest,Application,OperationMetadata> createApplicationOperationSettings()

Returns the object with the settings used for calls to createApplication.

Returns
Type	Description
`OperationCallSettings<CreateApplicationRequest,Application,OperationMetadata>`

createApplicationSettings()

public UnaryCallSettings<CreateApplicationRequest,Operation> createApplicationSettings()

Returns the object with the settings used for calls to createApplication.

Returns
Type	Description
`UnaryCallSettings<CreateApplicationRequest,Operation>`

createDraftOperationSettings()

public OperationCallSettings<CreateDraftRequest,Draft,OperationMetadata> createDraftOperationSettings()

Returns the object with the settings used for calls to createDraft.

Returns
Type	Description
`OperationCallSettings<CreateDraftRequest,Draft,OperationMetadata>`

createDraftSettings()

public UnaryCallSettings<CreateDraftRequest,Operation> createDraftSettings()

Returns the object with the settings used for calls to createDraft.

Returns
Type	Description
`UnaryCallSettings<CreateDraftRequest,Operation>`

createProcessorOperationSettings()

public OperationCallSettings<CreateProcessorRequest,Processor,OperationMetadata> createProcessorOperationSettings()

Returns the object with the settings used for calls to createProcessor.

Returns
Type	Description
`OperationCallSettings<CreateProcessorRequest,Processor,OperationMetadata>`

createProcessorSettings()

public UnaryCallSettings<CreateProcessorRequest,Operation> createProcessorSettings()

Returns the object with the settings used for calls to createProcessor.

Returns
Type	Description
`UnaryCallSettings<CreateProcessorRequest,Operation>`

deleteApplicationInstancesOperationSettings()

public OperationCallSettings<DeleteApplicationInstancesRequest,Instance,OperationMetadata> deleteApplicationInstancesOperationSettings()

Returns the object with the settings used for calls to deleteApplicationInstances.

Returns
Type	Description
`OperationCallSettings<DeleteApplicationInstancesRequest,Instance,OperationMetadata>`

deleteApplicationInstancesSettings()

public UnaryCallSettings<DeleteApplicationInstancesRequest,Operation> deleteApplicationInstancesSettings()

Returns the object with the settings used for calls to deleteApplicationInstances.

Returns
Type	Description
`UnaryCallSettings<DeleteApplicationInstancesRequest,Operation>`

deleteApplicationOperationSettings()

public OperationCallSettings<DeleteApplicationRequest,Empty,OperationMetadata> deleteApplicationOperationSettings()

Returns the object with the settings used for calls to deleteApplication.

Returns
Type	Description
`OperationCallSettings<DeleteApplicationRequest,Empty,OperationMetadata>`

deleteApplicationSettings()

public UnaryCallSettings<DeleteApplicationRequest,Operation> deleteApplicationSettings()

Returns the object with the settings used for calls to deleteApplication.

Returns
Type	Description
`UnaryCallSettings<DeleteApplicationRequest,Operation>`

deleteDraftOperationSettings()

public OperationCallSettings<DeleteDraftRequest,Empty,OperationMetadata> deleteDraftOperationSettings()

Returns the object with the settings used for calls to deleteDraft.

Returns
Type	Description
`OperationCallSettings<DeleteDraftRequest,Empty,OperationMetadata>`

deleteDraftSettings()

public UnaryCallSettings<DeleteDraftRequest,Operation> deleteDraftSettings()

Returns the object with the settings used for calls to deleteDraft.

Returns
Type	Description
`UnaryCallSettings<DeleteDraftRequest,Operation>`

deleteProcessorOperationSettings()

public OperationCallSettings<DeleteProcessorRequest,Empty,OperationMetadata> deleteProcessorOperationSettings()

Returns the object with the settings used for calls to deleteProcessor.

Returns
Type	Description
`OperationCallSettings<DeleteProcessorRequest,Empty,OperationMetadata>`

deleteProcessorSettings()

public UnaryCallSettings<DeleteProcessorRequest,Operation> deleteProcessorSettings()

Returns the object with the settings used for calls to deleteProcessor.

Returns
Type	Description
`UnaryCallSettings<DeleteProcessorRequest,Operation>`

deployApplicationOperationSettings()

public OperationCallSettings<DeployApplicationRequest,DeployApplicationResponse,OperationMetadata> deployApplicationOperationSettings()

Returns the object with the settings used for calls to deployApplication.

Returns
Type	Description
`OperationCallSettings<DeployApplicationRequest,DeployApplicationResponse,OperationMetadata>`

deployApplicationSettings()

public UnaryCallSettings<DeployApplicationRequest,Operation> deployApplicationSettings()

Returns the object with the settings used for calls to deployApplication.

Returns
Type	Description
`UnaryCallSettings<DeployApplicationRequest,Operation>`

getApplicationSettings()

public UnaryCallSettings<GetApplicationRequest,Application> getApplicationSettings()

Returns the object with the settings used for calls to getApplication.

Returns
Type	Description
`UnaryCallSettings<GetApplicationRequest,Application>`

getDraftSettings()

public UnaryCallSettings<GetDraftRequest,Draft> getDraftSettings()

Returns the object with the settings used for calls to getDraft.

Returns
Type	Description
`UnaryCallSettings<GetDraftRequest,Draft>`

getInstanceSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

Returns the object with the settings used for calls to getInstance.

Returns
Type	Description
`UnaryCallSettings<GetInstanceRequest,Instance>`

getProcessorSettings()

public UnaryCallSettings<GetProcessorRequest,Processor> getProcessorSettings()

Returns the object with the settings used for calls to getProcessor.

Returns
Type	Description
`UnaryCallSettings<GetProcessorRequest,Processor>`

listApplicationsSettings()

public PagedCallSettings<ListApplicationsRequest,ListApplicationsResponse,AppPlatformClient.ListApplicationsPagedResponse> listApplicationsSettings()

Returns the object with the settings used for calls to listApplications.

Returns
Type	Description
`PagedCallSettings<ListApplicationsRequest,ListApplicationsResponse,ListApplicationsPagedResponse>`

listDraftsSettings()

public PagedCallSettings<ListDraftsRequest,ListDraftsResponse,AppPlatformClient.ListDraftsPagedResponse> listDraftsSettings()

Returns the object with the settings used for calls to listDrafts.

Returns
Type	Description
`PagedCallSettings<ListDraftsRequest,ListDraftsResponse,ListDraftsPagedResponse>`

listInstancesSettings()

public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,AppPlatformClient.ListInstancesPagedResponse> listInstancesSettings()

Returns the object with the settings used for calls to listInstances.

Returns
Type	Description
`PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse>`

listPrebuiltProcessorsSettings()

public UnaryCallSettings<ListPrebuiltProcessorsRequest,ListPrebuiltProcessorsResponse> listPrebuiltProcessorsSettings()

Returns the object with the settings used for calls to listPrebuiltProcessors.

Returns
Type	Description
`UnaryCallSettings<ListPrebuiltProcessorsRequest,ListPrebuiltProcessorsResponse>`

listProcessorsSettings()

public PagedCallSettings<ListProcessorsRequest,ListProcessorsResponse,AppPlatformClient.ListProcessorsPagedResponse> listProcessorsSettings()

Returns the object with the settings used for calls to listProcessors.

Returns
Type	Description
`PagedCallSettings<ListProcessorsRequest,ListProcessorsResponse,ListProcessorsPagedResponse>`

removeApplicationStreamInputOperationSettings()

public OperationCallSettings<RemoveApplicationStreamInputRequest,RemoveApplicationStreamInputResponse,OperationMetadata> removeApplicationStreamInputOperationSettings()

Returns the object with the settings used for calls to removeApplicationStreamInput.

Returns
Type	Description
`OperationCallSettings<RemoveApplicationStreamInputRequest,RemoveApplicationStreamInputResponse,OperationMetadata>`

removeApplicationStreamInputSettings()

public UnaryCallSettings<RemoveApplicationStreamInputRequest,Operation> removeApplicationStreamInputSettings()

Returns the object with the settings used for calls to removeApplicationStreamInput.

Returns
Type	Description
`UnaryCallSettings<RemoveApplicationStreamInputRequest,Operation>`

toBuilder()

public AppPlatformSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type	Description
`AppPlatformSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

undeployApplicationOperationSettings()

public OperationCallSettings<UndeployApplicationRequest,UndeployApplicationResponse,OperationMetadata> undeployApplicationOperationSettings()

Returns the object with the settings used for calls to undeployApplication.

Returns
Type	Description
`OperationCallSettings<UndeployApplicationRequest,UndeployApplicationResponse,OperationMetadata>`

undeployApplicationSettings()

public UnaryCallSettings<UndeployApplicationRequest,Operation> undeployApplicationSettings()

Returns the object with the settings used for calls to undeployApplication.

Returns
Type	Description
`UnaryCallSettings<UndeployApplicationRequest,Operation>`

updateApplicationInstancesOperationSettings()

public OperationCallSettings<UpdateApplicationInstancesRequest,UpdateApplicationInstancesResponse,OperationMetadata> updateApplicationInstancesOperationSettings()

Returns the object with the settings used for calls to updateApplicationInstances.

Returns
Type	Description
`OperationCallSettings<UpdateApplicationInstancesRequest,UpdateApplicationInstancesResponse,OperationMetadata>`

updateApplicationInstancesSettings()

public UnaryCallSettings<UpdateApplicationInstancesRequest,Operation> updateApplicationInstancesSettings()

Returns the object with the settings used for calls to updateApplicationInstances.

Returns
Type	Description
`UnaryCallSettings<UpdateApplicationInstancesRequest,Operation>`

updateApplicationOperationSettings()

public OperationCallSettings<UpdateApplicationRequest,Application,OperationMetadata> updateApplicationOperationSettings()

Returns the object with the settings used for calls to updateApplication.

Returns
Type	Description
`OperationCallSettings<UpdateApplicationRequest,Application,OperationMetadata>`

updateApplicationSettings()

public UnaryCallSettings<UpdateApplicationRequest,Operation> updateApplicationSettings()

Returns the object with the settings used for calls to updateApplication.

Returns
Type	Description
`UnaryCallSettings<UpdateApplicationRequest,Operation>`

updateApplicationStreamInputOperationSettings()

public OperationCallSettings<UpdateApplicationStreamInputRequest,UpdateApplicationStreamInputResponse,OperationMetadata> updateApplicationStreamInputOperationSettings()

Returns the object with the settings used for calls to updateApplicationStreamInput.

Returns
Type	Description
`OperationCallSettings<UpdateApplicationStreamInputRequest,UpdateApplicationStreamInputResponse,OperationMetadata>`

updateApplicationStreamInputSettings()

public UnaryCallSettings<UpdateApplicationStreamInputRequest,Operation> updateApplicationStreamInputSettings()

Returns the object with the settings used for calls to updateApplicationStreamInput.

Returns
Type	Description
`UnaryCallSettings<UpdateApplicationStreamInputRequest,Operation>`

updateDraftOperationSettings()

public OperationCallSettings<UpdateDraftRequest,Draft,OperationMetadata> updateDraftOperationSettings()

Returns the object with the settings used for calls to updateDraft.

Returns
Type	Description
`OperationCallSettings<UpdateDraftRequest,Draft,OperationMetadata>`

updateDraftSettings()

public UnaryCallSettings<UpdateDraftRequest,Operation> updateDraftSettings()

Returns the object with the settings used for calls to updateDraft.

Returns
Type	Description
`UnaryCallSettings<UpdateDraftRequest,Operation>`

updateProcessorOperationSettings()

public OperationCallSettings<UpdateProcessorRequest,Processor,OperationMetadata> updateProcessorOperationSettings()

Returns the object with the settings used for calls to updateProcessor.

Returns
Type	Description
`OperationCallSettings<UpdateProcessorRequest,Processor,OperationMetadata>`

updateProcessorSettings()

public UnaryCallSettings<UpdateProcessorRequest,Operation> updateProcessorSettings()

Returns the object with the settings used for calls to updateProcessor.

Returns
Type	Description
`UnaryCallSettings<UpdateProcessorRequest,Operation>`