Class IndexServiceSettings (2.4.0) 

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 total timeout of getIndex to 30 seconds:


 IndexServiceSettings.Builder indexServiceSettingsBuilder = IndexServiceSettings.newBuilder();
 indexServiceSettingsBuilder
     .getIndexSettings()
     .setRetrySettings(
         indexServiceSettingsBuilder
             .getIndexSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 IndexServiceSettings indexServiceSettings = indexServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > IndexServiceSettings

Constructors

IndexServiceSettings(IndexServiceSettings.Builder settingsBuilder)

protected IndexServiceSettings(IndexServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderIndexServiceSettings.Builder

Methods

create(IndexServiceStubSettings stub)

public static final IndexServiceSettings create(IndexServiceStubSettings stub)
Parameter
NameDescription
stubIndexServiceStubSettings
Returns
TypeDescription
IndexServiceSettings
Exceptions
TypeDescription
IOException

createIndexOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateIndexRequest,Index,CreateIndexOperationMetadata>

createIndexSettings()

public UnaryCallSettings<CreateIndexRequest,Operation> createIndexSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateIndexRequest,Operation>

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

deleteIndexOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteIndexRequest,Empty,DeleteOperationMetadata>

deleteIndexSettings()

public UnaryCallSettings<DeleteIndexRequest,Operation> deleteIndexSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteIndexRequest,Operation>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

getIndexSettings()

public UnaryCallSettings<GetIndexRequest,Index> getIndexSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetIndexRequest,Index>

listIndexesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListIndexesRequest,ListIndexesResponse,ListIndexesPagedResponse>

newBuilder()

public static IndexServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
IndexServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static IndexServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
IndexServiceSettings.Builder

toBuilder()

public IndexServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
IndexServiceSettings.Builder
Overrides

updateIndexOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateIndexRequest,Index,UpdateIndexOperationMetadata>

updateIndexSettings()

public UnaryCallSettings<UpdateIndexRequest,Operation> updateIndexSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateIndexRequest,Operation>