Class IndexEndpointServiceStubSettings
- java.lang.Object
-
- com.google.api.gax.rpc.StubSettings<IndexEndpointServiceStubSettings>
-
- com.google.cloud.aiplatform.v1.stub.IndexEndpointServiceStubSettings
-
@Generated("by gapic-generator-java") public class IndexEndpointServiceStubSettings extends com.google.api.gax.rpc.StubSettings<IndexEndpointServiceStubSettings>
Settings class to configure an instance ofIndexEndpointServiceStub
.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 IndexEndpointServiceStubSettings.Builder indexEndpointServiceSettingsBuilder = IndexEndpointServiceStubSettings.newBuilder(); indexEndpointServiceSettingsBuilder .getIndexEndpointSettings() .setRetrySettings( indexEndpointServiceSettingsBuilder .getIndexEndpointSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); IndexEndpointServiceStubSettings indexEndpointServiceSettings = indexEndpointServiceSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IndexEndpointServiceStubSettings.Builder
Builder for IndexEndpointServiceStubSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
IndexEndpointServiceStubSettings(IndexEndpointServiceStubSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.rpc.OperationCallSettings<CreateIndexEndpointRequest,IndexEndpoint,CreateIndexEndpointOperationMetadata>
createIndexEndpointOperationSettings()
Returns the object with the settings used for calls to createIndexEndpoint.com.google.api.gax.rpc.UnaryCallSettings<CreateIndexEndpointRequest,com.google.longrunning.Operation>
createIndexEndpointSettings()
Returns the object with the settings used for calls to createIndexEndpoint.IndexEndpointServiceStub
createStub()
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<DeleteIndexEndpointRequest,com.google.protobuf.Empty,DeleteOperationMetadata>
deleteIndexEndpointOperationSettings()
Returns the object with the settings used for calls to deleteIndexEndpoint.com.google.api.gax.rpc.UnaryCallSettings<DeleteIndexEndpointRequest,com.google.longrunning.Operation>
deleteIndexEndpointSettings()
Returns the object with the settings used for calls to deleteIndexEndpoint.com.google.api.gax.rpc.OperationCallSettings<DeployIndexRequest,DeployIndexResponse,DeployIndexOperationMetadata>
deployIndexOperationSettings()
Returns the object with the settings used for calls to deployIndex.com.google.api.gax.rpc.UnaryCallSettings<DeployIndexRequest,com.google.longrunning.Operation>
deployIndexSettings()
Returns the object with the settings used for calls to deployIndex.static String
getDefaultEndpoint()
Returns the default service endpoint.static String
getDefaultMtlsEndpoint()
Returns the default mTLS 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<GetIndexEndpointRequest,IndexEndpoint>
getIndexEndpointSettings()
Returns the object with the settings used for calls to getIndexEndpoint.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<ListIndexEndpointsRequest,ListIndexEndpointsResponse,IndexEndpointServiceClient.ListIndexEndpointsPagedResponse>
listIndexEndpointsSettings()
Returns the object with the settings used for calls to listIndexEndpoints.com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,IndexEndpointServiceClient.ListLocationsPagedResponse>
listLocationsSettings()
Returns the object with the settings used for calls to listLocations.com.google.api.gax.rpc.OperationCallSettings<MutateDeployedIndexRequest,MutateDeployedIndexResponse,MutateDeployedIndexOperationMetadata>
mutateDeployedIndexOperationSettings()
Returns the object with the settings used for calls to mutateDeployedIndex.com.google.api.gax.rpc.UnaryCallSettings<MutateDeployedIndexRequest,com.google.longrunning.Operation>
mutateDeployedIndexSettings()
Returns the object with the settings used for calls to mutateDeployedIndex.static IndexEndpointServiceStubSettings.Builder
newBuilder()
Returns a new builder for this class.static IndexEndpointServiceStubSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.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.IndexEndpointServiceStubSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.OperationCallSettings<UndeployIndexRequest,UndeployIndexResponse,UndeployIndexOperationMetadata>
undeployIndexOperationSettings()
Returns the object with the settings used for calls to undeployIndex.com.google.api.gax.rpc.UnaryCallSettings<UndeployIndexRequest,com.google.longrunning.Operation>
undeployIndexSettings()
Returns the object with the settings used for calls to undeployIndex.com.google.api.gax.rpc.UnaryCallSettings<UpdateIndexEndpointRequest,IndexEndpoint>
updateIndexEndpointSettings()
Returns the object with the settings used for calls to updateIndexEndpoint.-
Methods inherited from class com.google.api.gax.rpc.StubSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString
-
-
-
-
Constructor Detail
-
IndexEndpointServiceStubSettings
protected IndexEndpointServiceStubSettings(IndexEndpointServiceStubSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
createIndexEndpointSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateIndexEndpointRequest,com.google.longrunning.Operation> createIndexEndpointSettings()
Returns the object with the settings used for calls to createIndexEndpoint.
-
createIndexEndpointOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<CreateIndexEndpointRequest,IndexEndpoint,CreateIndexEndpointOperationMetadata> createIndexEndpointOperationSettings()
Returns the object with the settings used for calls to createIndexEndpoint.
-
getIndexEndpointSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetIndexEndpointRequest,IndexEndpoint> getIndexEndpointSettings()
Returns the object with the settings used for calls to getIndexEndpoint.
-
listIndexEndpointsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListIndexEndpointsRequest,ListIndexEndpointsResponse,IndexEndpointServiceClient.ListIndexEndpointsPagedResponse> listIndexEndpointsSettings()
Returns the object with the settings used for calls to listIndexEndpoints.
-
updateIndexEndpointSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateIndexEndpointRequest,IndexEndpoint> updateIndexEndpointSettings()
Returns the object with the settings used for calls to updateIndexEndpoint.
-
deleteIndexEndpointSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteIndexEndpointRequest,com.google.longrunning.Operation> deleteIndexEndpointSettings()
Returns the object with the settings used for calls to deleteIndexEndpoint.
-
deleteIndexEndpointOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<DeleteIndexEndpointRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteIndexEndpointOperationSettings()
Returns the object with the settings used for calls to deleteIndexEndpoint.
-
deployIndexSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeployIndexRequest,com.google.longrunning.Operation> deployIndexSettings()
Returns the object with the settings used for calls to deployIndex.
-
deployIndexOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<DeployIndexRequest,DeployIndexResponse,DeployIndexOperationMetadata> deployIndexOperationSettings()
Returns the object with the settings used for calls to deployIndex.
-
undeployIndexSettings
public com.google.api.gax.rpc.UnaryCallSettings<UndeployIndexRequest,com.google.longrunning.Operation> undeployIndexSettings()
Returns the object with the settings used for calls to undeployIndex.
-
undeployIndexOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<UndeployIndexRequest,UndeployIndexResponse,UndeployIndexOperationMetadata> undeployIndexOperationSettings()
Returns the object with the settings used for calls to undeployIndex.
-
mutateDeployedIndexSettings
public com.google.api.gax.rpc.UnaryCallSettings<MutateDeployedIndexRequest,com.google.longrunning.Operation> mutateDeployedIndexSettings()
Returns the object with the settings used for calls to mutateDeployedIndex.
-
mutateDeployedIndexOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<MutateDeployedIndexRequest,MutateDeployedIndexResponse,MutateDeployedIndexOperationMetadata> mutateDeployedIndexOperationSettings()
Returns the object with the settings used for calls to mutateDeployedIndex.
-
listLocationsSettings
public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,IndexEndpointServiceClient.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.
-
createStub
public IndexEndpointServiceStub createStub() 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.
-
getDefaultMtlsEndpoint
public static String getDefaultMtlsEndpoint()
Returns the default mTLS 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
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static IndexEndpointServiceStubSettings.Builder newBuilder()
Returns a new builder for this class.
-
newBuilder
public static IndexEndpointServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public IndexEndpointServiceStubSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.StubSettings<IndexEndpointServiceStubSettings>
-
-