com.google.cloud.aiplatform.v1.IndexServiceSettings Maven / Gradle / Ivy
Show all versions of google-cloud-aiplatform Show documentation
/*
* Copyright 2023 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.aiplatform.v1;
import static com.google.cloud.aiplatform.v1.IndexServiceClient.ListIndexesPagedResponse;
import static com.google.cloud.aiplatform.v1.IndexServiceClient.ListLocationsPagedResponse;
import com.google.api.core.ApiFunction;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.ClientSettings;
import com.google.api.gax.rpc.OperationCallSettings;
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.cloud.aiplatform.v1.stub.IndexServiceStubSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.longrunning.Operation;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Settings class to configure an instance of {@link 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:
*
*
{@code
* // 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();
* }
*/
@Generated("by gapic-generator-java")
public class IndexServiceSettings extends ClientSettings {
/** Returns the object with the settings used for calls to createIndex. */
public UnaryCallSettings createIndexSettings() {
return ((IndexServiceStubSettings) getStubSettings()).createIndexSettings();
}
/** Returns the object with the settings used for calls to createIndex. */
public OperationCallSettings
createIndexOperationSettings() {
return ((IndexServiceStubSettings) getStubSettings()).createIndexOperationSettings();
}
/** Returns the object with the settings used for calls to getIndex. */
public UnaryCallSettings getIndexSettings() {
return ((IndexServiceStubSettings) getStubSettings()).getIndexSettings();
}
/** Returns the object with the settings used for calls to listIndexes. */
public PagedCallSettings
listIndexesSettings() {
return ((IndexServiceStubSettings) getStubSettings()).listIndexesSettings();
}
/** Returns the object with the settings used for calls to updateIndex. */
public UnaryCallSettings updateIndexSettings() {
return ((IndexServiceStubSettings) getStubSettings()).updateIndexSettings();
}
/** Returns the object with the settings used for calls to updateIndex. */
public OperationCallSettings
updateIndexOperationSettings() {
return ((IndexServiceStubSettings) getStubSettings()).updateIndexOperationSettings();
}
/** Returns the object with the settings used for calls to deleteIndex. */
public UnaryCallSettings deleteIndexSettings() {
return ((IndexServiceStubSettings) getStubSettings()).deleteIndexSettings();
}
/** Returns the object with the settings used for calls to deleteIndex. */
public OperationCallSettings
deleteIndexOperationSettings() {
return ((IndexServiceStubSettings) getStubSettings()).deleteIndexOperationSettings();
}
/** Returns the object with the settings used for calls to upsertDatapoints. */
public UnaryCallSettings
upsertDatapointsSettings() {
return ((IndexServiceStubSettings) getStubSettings()).upsertDatapointsSettings();
}
/** Returns the object with the settings used for calls to removeDatapoints. */
public UnaryCallSettings
removeDatapointsSettings() {
return ((IndexServiceStubSettings) getStubSettings()).removeDatapointsSettings();
}
/** Returns the object with the settings used for calls to listLocations. */
public PagedCallSettings
listLocationsSettings() {
return ((IndexServiceStubSettings) getStubSettings()).listLocationsSettings();
}
/** Returns the object with the settings used for calls to getLocation. */
public UnaryCallSettings getLocationSettings() {
return ((IndexServiceStubSettings) getStubSettings()).getLocationSettings();
}
/** Returns the object with the settings used for calls to setIamPolicy. */
public UnaryCallSettings setIamPolicySettings() {
return ((IndexServiceStubSettings) getStubSettings()).setIamPolicySettings();
}
/** Returns the object with the settings used for calls to getIamPolicy. */
public UnaryCallSettings getIamPolicySettings() {
return ((IndexServiceStubSettings) getStubSettings()).getIamPolicySettings();
}
/** Returns the object with the settings used for calls to testIamPermissions. */
public UnaryCallSettings
testIamPermissionsSettings() {
return ((IndexServiceStubSettings) getStubSettings()).testIamPermissionsSettings();
}
public static final IndexServiceSettings create(IndexServiceStubSettings stub)
throws IOException {
return new IndexServiceSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return IndexServiceStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return IndexServiceStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return IndexServiceStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return IndexServiceStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return IndexServiceStubSettings.defaultGrpcTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return IndexServiceStubSettings.defaultTransportChannelProvider();
}
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return IndexServiceStubSettings.defaultApiClientHeaderProviderBuilder();
}
/** Returns a new builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** Returns a new builder for this class. */
public static Builder newBuilder(ClientContext clientContext) {
return new Builder(clientContext);
}
/** Returns a builder containing all the values of this settings class. */
public Builder toBuilder() {
return new Builder(this);
}
protected IndexServiceSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for IndexServiceSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(IndexServiceStubSettings.newBuilder(clientContext));
}
protected Builder(IndexServiceSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(IndexServiceStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(IndexServiceStubSettings.newBuilder());
}
public IndexServiceStubSettings.Builder getStubSettingsBuilder() {
return ((IndexServiceStubSettings.Builder) getStubSettings());
}
/**
* Applies the given settings updater function to all of the unary API methods in this service.
*
* Note: This method does not support applying settings to streaming methods.
*/
public Builder applyToAllUnaryMethods(
ApiFunction, Void> settingsUpdater) {
super.applyToAllUnaryMethods(
getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
return this;
}
/** Returns the builder for the settings used for calls to createIndex. */
public UnaryCallSettings.Builder createIndexSettings() {
return getStubSettingsBuilder().createIndexSettings();
}
/** Returns the builder for the settings used for calls to createIndex. */
public OperationCallSettings.Builder
createIndexOperationSettings() {
return getStubSettingsBuilder().createIndexOperationSettings();
}
/** Returns the builder for the settings used for calls to getIndex. */
public UnaryCallSettings.Builder getIndexSettings() {
return getStubSettingsBuilder().getIndexSettings();
}
/** Returns the builder for the settings used for calls to listIndexes. */
public PagedCallSettings.Builder<
ListIndexesRequest, ListIndexesResponse, ListIndexesPagedResponse>
listIndexesSettings() {
return getStubSettingsBuilder().listIndexesSettings();
}
/** Returns the builder for the settings used for calls to updateIndex. */
public UnaryCallSettings.Builder updateIndexSettings() {
return getStubSettingsBuilder().updateIndexSettings();
}
/** Returns the builder for the settings used for calls to updateIndex. */
public OperationCallSettings.Builder
updateIndexOperationSettings() {
return getStubSettingsBuilder().updateIndexOperationSettings();
}
/** Returns the builder for the settings used for calls to deleteIndex. */
public UnaryCallSettings.Builder deleteIndexSettings() {
return getStubSettingsBuilder().deleteIndexSettings();
}
/** Returns the builder for the settings used for calls to deleteIndex. */
public OperationCallSettings.Builder
deleteIndexOperationSettings() {
return getStubSettingsBuilder().deleteIndexOperationSettings();
}
/** Returns the builder for the settings used for calls to upsertDatapoints. */
public UnaryCallSettings.Builder
upsertDatapointsSettings() {
return getStubSettingsBuilder().upsertDatapointsSettings();
}
/** Returns the builder for the settings used for calls to removeDatapoints. */
public UnaryCallSettings.Builder
removeDatapointsSettings() {
return getStubSettingsBuilder().removeDatapointsSettings();
}
/** Returns the builder for the settings used for calls to listLocations. */
public PagedCallSettings.Builder<
ListLocationsRequest, ListLocationsResponse, ListLocationsPagedResponse>
listLocationsSettings() {
return getStubSettingsBuilder().listLocationsSettings();
}
/** Returns the builder for the settings used for calls to getLocation. */
public UnaryCallSettings.Builder getLocationSettings() {
return getStubSettingsBuilder().getLocationSettings();
}
/** Returns the builder for the settings used for calls to setIamPolicy. */
public UnaryCallSettings.Builder setIamPolicySettings() {
return getStubSettingsBuilder().setIamPolicySettings();
}
/** Returns the builder for the settings used for calls to getIamPolicy. */
public UnaryCallSettings.Builder getIamPolicySettings() {
return getStubSettingsBuilder().getIamPolicySettings();
}
/** Returns the builder for the settings used for calls to testIamPermissions. */
public UnaryCallSettings.Builder
testIamPermissionsSettings() {
return getStubSettingsBuilder().testIamPermissionsSettings();
}
@Override
public IndexServiceSettings build() throws IOException {
return new IndexServiceSettings(this);
}
}
}