com.google.cloud.aiplatform.v1beta1

Class IndexServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<IndexServiceSettings>

com.google.cloud.aiplatform.v1beta1.IndexServiceSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class IndexServiceSettings
extends com.google.api.gax.rpc.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:

 // 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()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 IndexServiceSettings indexServiceSettings = indexServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexServiceSettings.Builder Builder for IndexServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IndexServiceSettings(IndexServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static IndexServiceSettings	create(IndexServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateIndexRequest,Index,CreateIndexOperationMetadata>	createIndexOperationSettings() Returns the object with the settings used for calls to createIndex.
com.google.api.gax.rpc.UnaryCallSettings<CreateIndexRequest,com.google.longrunning.Operation>	createIndexSettings() Returns the object with the settings used for calls to createIndex.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteIndexRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteIndexOperationSettings() Returns the object with the settings used for calls to deleteIndex.
com.google.api.gax.rpc.UnaryCallSettings<DeleteIndexRequest,com.google.longrunning.Operation>	deleteIndexSettings() Returns the object with the settings used for calls to deleteIndex.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<GetIndexRequest,Index>	getIndexSettings() Returns the object with the settings used for calls to getIndex.
com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationSettings() Returns the object with the settings used for calls to getLocation.
com.google.api.gax.rpc.PagedCallSettings<ListIndexesRequest,ListIndexesResponse,IndexServiceClient.ListIndexesPagedResponse>	listIndexesSettings() Returns the object with the settings used for calls to listIndexes.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,IndexServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
static IndexServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static IndexServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<RemoveDatapointsRequest,RemoveDatapointsResponse>	removeDatapointsSettings() Returns the object with the settings used for calls to removeDatapoints.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
IndexServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateIndexRequest,Index,UpdateIndexOperationMetadata>	updateIndexOperationSettings() Returns the object with the settings used for calls to updateIndex.
com.google.api.gax.rpc.UnaryCallSettings<UpdateIndexRequest,com.google.longrunning.Operation>	updateIndexSettings() Returns the object with the settings used for calls to updateIndex.
com.google.api.gax.rpc.UnaryCallSettings<UpsertDatapointsRequest,UpsertDatapointsResponse>	upsertDatapointsSettings() Returns the object with the settings used for calls to upsertDatapoints.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexServiceSettings

protected IndexServiceSettings(IndexServiceSettings.Builder settingsBuilder)
                        throws IOException

Throws:

IOException

Method Detail

createIndexSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateIndexRequest,com.google.longrunning.Operation> createIndexSettings()

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

createIndexOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateIndexRequest,Index,CreateIndexOperationMetadata> createIndexOperationSettings()

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

getIndexSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetIndexRequest,Index> getIndexSettings()

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

listIndexesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListIndexesRequest,ListIndexesResponse,IndexServiceClient.ListIndexesPagedResponse> listIndexesSettings()

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

updateIndexSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateIndexRequest,com.google.longrunning.Operation> updateIndexSettings()

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

updateIndexOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateIndexRequest,Index,UpdateIndexOperationMetadata> updateIndexOperationSettings()

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

deleteIndexSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteIndexRequest,com.google.longrunning.Operation> deleteIndexSettings()

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

deleteIndexOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteIndexRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteIndexOperationSettings()

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

upsertDatapointsSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpsertDatapointsRequest,UpsertDatapointsResponse> upsertDatapointsSettings()

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

removeDatapointsSettings

public com.google.api.gax.rpc.UnaryCallSettings<RemoveDatapointsRequest,RemoveDatapointsResponse> removeDatapointsSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,IndexServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

getLocationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()

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

setIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

getIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

testIamPermissionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

create

public static final IndexServiceSettings create(IndexServiceStubSettings stub)
                                         throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static IndexServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static IndexServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public IndexServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<IndexServiceSettings>