- 3.48.0 (latest)
- 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
public class IndexEndpointServiceSettings extends ClientSettings<IndexEndpointServiceSettings>
Settings class to configure an instance of IndexEndpointServiceClient.
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 getIndexEndpoint 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
IndexEndpointServiceSettings.Builder indexEndpointServiceSettingsBuilder =
IndexEndpointServiceSettings.newBuilder();
indexEndpointServiceSettingsBuilder
.getIndexEndpointSettings()
.setRetrySettings(
indexEndpointServiceSettingsBuilder
.getIndexEndpointSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
IndexEndpointServiceSettings indexEndpointServiceSettings =
indexEndpointServiceSettingsBuilder.build();
Static Methods
create(IndexEndpointServiceStubSettings stub)
public static final IndexEndpointServiceSettings create(IndexEndpointServiceStubSettings stub)
Parameter | |
---|---|
Name | Description |
stub | IndexEndpointServiceStubSettings |
Returns | |
---|---|
Type | Description |
IndexEndpointServiceSettings |
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 IndexEndpointServiceSettings.Builder newBuilder()
Returns a new builder for this class.
Returns | |
---|---|
Type | Description |
IndexEndpointServiceSettings.Builder |
newBuilder(ClientContext clientContext)
public static IndexEndpointServiceSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
Parameter | |
---|---|
Name | Description |
clientContext | ClientContext |
Returns | |
---|---|
Type | Description |
IndexEndpointServiceSettings.Builder |
Constructors
IndexEndpointServiceSettings(IndexEndpointServiceSettings.Builder settingsBuilder)
protected IndexEndpointServiceSettings(IndexEndpointServiceSettings.Builder settingsBuilder)
Parameter | |
---|---|
Name | Description |
settingsBuilder | IndexEndpointServiceSettings.Builder |
Methods
createIndexEndpointOperationSettings()
public OperationCallSettings<CreateIndexEndpointRequest,IndexEndpoint,CreateIndexEndpointOperationMetadata> createIndexEndpointOperationSettings()
Returns the object with the settings used for calls to createIndexEndpoint.
Returns | |
---|---|
Type | Description |
OperationCallSettings<CreateIndexEndpointRequest,IndexEndpoint,CreateIndexEndpointOperationMetadata> |
createIndexEndpointSettings()
public UnaryCallSettings<CreateIndexEndpointRequest,Operation> createIndexEndpointSettings()
Returns the object with the settings used for calls to createIndexEndpoint.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<CreateIndexEndpointRequest,Operation> |
deleteIndexEndpointOperationSettings()
public OperationCallSettings<DeleteIndexEndpointRequest,Empty,DeleteOperationMetadata> deleteIndexEndpointOperationSettings()
Returns the object with the settings used for calls to deleteIndexEndpoint.
Returns | |
---|---|
Type | Description |
OperationCallSettings<DeleteIndexEndpointRequest,Empty,DeleteOperationMetadata> |
deleteIndexEndpointSettings()
public UnaryCallSettings<DeleteIndexEndpointRequest,Operation> deleteIndexEndpointSettings()
Returns the object with the settings used for calls to deleteIndexEndpoint.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<DeleteIndexEndpointRequest,Operation> |
deployIndexOperationSettings()
public OperationCallSettings<DeployIndexRequest,DeployIndexResponse,DeployIndexOperationMetadata> deployIndexOperationSettings()
Returns the object with the settings used for calls to deployIndex.
Returns | |
---|---|
Type | Description |
OperationCallSettings<DeployIndexRequest,DeployIndexResponse,DeployIndexOperationMetadata> |
deployIndexSettings()
public UnaryCallSettings<DeployIndexRequest,Operation> deployIndexSettings()
Returns the object with the settings used for calls to deployIndex.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<DeployIndexRequest,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> |
getIndexEndpointSettings()
public UnaryCallSettings<GetIndexEndpointRequest,IndexEndpoint> getIndexEndpointSettings()
Returns the object with the settings used for calls to getIndexEndpoint.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetIndexEndpointRequest,IndexEndpoint> |
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> |
listIndexEndpointsSettings()
public PagedCallSettings<ListIndexEndpointsRequest,ListIndexEndpointsResponse,IndexEndpointServiceClient.ListIndexEndpointsPagedResponse> listIndexEndpointsSettings()
Returns the object with the settings used for calls to listIndexEndpoints.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListIndexEndpointsRequest,ListIndexEndpointsResponse,ListIndexEndpointsPagedResponse> |
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,IndexEndpointServiceClient.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> |
mutateDeployedIndexOperationSettings()
public OperationCallSettings<MutateDeployedIndexRequest,MutateDeployedIndexResponse,MutateDeployedIndexOperationMetadata> mutateDeployedIndexOperationSettings()
Returns the object with the settings used for calls to mutateDeployedIndex.
Returns | |
---|---|
Type | Description |
OperationCallSettings<MutateDeployedIndexRequest,MutateDeployedIndexResponse,MutateDeployedIndexOperationMetadata> |
mutateDeployedIndexSettings()
public UnaryCallSettings<MutateDeployedIndexRequest,Operation> mutateDeployedIndexSettings()
Returns the object with the settings used for calls to mutateDeployedIndex.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<MutateDeployedIndexRequest,Operation> |
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 IndexEndpointServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
Returns | |
---|---|
Type | Description |
IndexEndpointServiceSettings.Builder |
undeployIndexOperationSettings()
public OperationCallSettings<UndeployIndexRequest,UndeployIndexResponse,UndeployIndexOperationMetadata> undeployIndexOperationSettings()
Returns the object with the settings used for calls to undeployIndex.
Returns | |
---|---|
Type | Description |
OperationCallSettings<UndeployIndexRequest,UndeployIndexResponse,UndeployIndexOperationMetadata> |
undeployIndexSettings()
public UnaryCallSettings<UndeployIndexRequest,Operation> undeployIndexSettings()
Returns the object with the settings used for calls to undeployIndex.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<UndeployIndexRequest,Operation> |
updateIndexEndpointSettings()
public UnaryCallSettings<UpdateIndexEndpointRequest,IndexEndpoint> updateIndexEndpointSettings()
Returns the object with the settings used for calls to updateIndexEndpoint.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<UpdateIndexEndpointRequest,IndexEndpoint> |