Class IndexServiceSettings (3.54.0)

Version 3.54.0

• 3.55.0 (latest)
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

public class IndexServiceSettings extends ClientSettings<IndexServiceSettings>

Settings class to configure an instance of IndexServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.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 getIndex:

 // 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
 IndexServiceSettings.Builder indexServiceSettingsBuilder = IndexServiceSettings.newBuilder();
 indexServiceSettingsBuilder
     .getIndexSettings()
     .setRetrySettings(
         indexServiceSettingsBuilder
             .getIndexSettings()
             .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());
 IndexServiceSettings indexServiceSettings = indexServiceSettingsBuilder.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 createIndex:

 // 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
 IndexServiceSettings.Builder indexServiceSettingsBuilder = IndexServiceSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 indexServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > ClientSettings > IndexServiceSettings

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(IndexServiceStubSettings stub)

public static final IndexServiceSettings create(IndexServiceStubSettings stub)

Parameter
Name	Description
stub	IndexServiceStubSettings

Returns
Type	Description
IndexServiceSettings

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 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 IndexServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
IndexServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static IndexServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
IndexServiceSettings.Builder

Constructors

IndexServiceSettings(IndexServiceSettings.Builder settingsBuilder)

protected IndexServiceSettings(IndexServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	IndexServiceSettings.Builder

Methods

createIndexOperationSettings()

public OperationCallSettings<CreateIndexRequest,Index,CreateIndexOperationMetadata> createIndexOperationSettings()

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

Returns
Type	Description
OperationCallSettings<CreateIndexRequest,Index,CreateIndexOperationMetadata>

createIndexSettings()

public UnaryCallSettings<CreateIndexRequest,Operation> createIndexSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateIndexRequest,Operation>

deleteIndexOperationSettings()

public OperationCallSettings<DeleteIndexRequest,Empty,DeleteOperationMetadata> deleteIndexOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteIndexRequest,Empty,DeleteOperationMetadata>

deleteIndexSettings()

public UnaryCallSettings<DeleteIndexRequest,Operation> deleteIndexSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteIndexRequest,Operation>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getIndexSettings()

public UnaryCallSettings<GetIndexRequest,Index> getIndexSettings()

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

Returns
Type	Description
UnaryCallSettings<GetIndexRequest,Index>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

listIndexesSettings()

public PagedCallSettings<ListIndexesRequest,ListIndexesResponse,IndexServiceClient.ListIndexesPagedResponse> listIndexesSettings()

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

Returns
Type	Description
PagedCallSettings<ListIndexesRequest,ListIndexesResponse,ListIndexesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,IndexServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type	Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

removeDatapointsSettings()

public UnaryCallSettings<RemoveDatapointsRequest,RemoveDatapointsResponse> removeDatapointsSettings()

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

Returns
Type	Description
UnaryCallSettings<RemoveDatapointsRequest,RemoveDatapointsResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public IndexServiceSettings.Builder toBuilder()

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

Returns
Type	Description
IndexServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateIndexOperationSettings()

public OperationCallSettings<UpdateIndexRequest,Index,UpdateIndexOperationMetadata> updateIndexOperationSettings()

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

Returns
Type	Description
OperationCallSettings<UpdateIndexRequest,Index,UpdateIndexOperationMetadata>

updateIndexSettings()

public UnaryCallSettings<UpdateIndexRequest,Operation> updateIndexSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateIndexRequest,Operation>

upsertDatapointsSettings()

public UnaryCallSettings<UpsertDatapointsRequest,UpsertDatapointsResponse> upsertDatapointsSettings()

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

Returns
Type	Description
UnaryCallSettings<UpsertDatapointsRequest,UpsertDatapointsResponse>