Class IndexServiceStubSettings (2.9.5) 

public class IndexServiceStubSettings extends StubSettings<IndexServiceStubSettings>

Settings class to configure an instance of IndexServiceStub.

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:


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

Inheritance

java.lang.Object > StubSettings > IndexServiceStubSettings

Static Methods

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

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static IndexServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
IndexServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static IndexServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
IndexServiceStubSettings.Builder

Constructors

IndexServiceStubSettings(IndexServiceStubSettings.Builder settingsBuilder)

protected IndexServiceStubSettings(IndexServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderIndexServiceStubSettings.Builder

Methods

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>

createStub()

public IndexServiceStub createStub()
Returns
TypeDescription
IndexServiceStub
Exceptions
TypeDescription
IOException

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>

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>

toBuilder()

public IndexServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
IndexServiceStubSettings.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>