com.google.cloud.aiplatform.v1beta1.IndexEndpointServiceSettings 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.v1beta1;
import static com.google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient.ListIndexEndpointsPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.IndexEndpointServiceClient.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.v1beta1.stub.IndexEndpointServiceStubSettings;
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 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:
*
*
{@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
* IndexEndpointServiceSettings.Builder indexEndpointServiceSettingsBuilder =
* IndexEndpointServiceSettings.newBuilder();
* indexEndpointServiceSettingsBuilder
* .getIndexEndpointSettings()
* .setRetrySettings(
* indexEndpointServiceSettingsBuilder
* .getIndexEndpointSettings()
* .getRetrySettings()
* .toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* IndexEndpointServiceSettings indexEndpointServiceSettings =
* indexEndpointServiceSettingsBuilder.build();
* }
*/
@BetaApi
@Generated("by gapic-generator-java")
public class IndexEndpointServiceSettings extends ClientSettings {
/** Returns the object with the settings used for calls to createIndexEndpoint. */
public UnaryCallSettings createIndexEndpointSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).createIndexEndpointSettings();
}
/** Returns the object with the settings used for calls to createIndexEndpoint. */
public OperationCallSettings<
CreateIndexEndpointRequest, IndexEndpoint, CreateIndexEndpointOperationMetadata>
createIndexEndpointOperationSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings())
.createIndexEndpointOperationSettings();
}
/** Returns the object with the settings used for calls to getIndexEndpoint. */
public UnaryCallSettings getIndexEndpointSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).getIndexEndpointSettings();
}
/** Returns the object with the settings used for calls to listIndexEndpoints. */
public PagedCallSettings<
ListIndexEndpointsRequest, ListIndexEndpointsResponse, ListIndexEndpointsPagedResponse>
listIndexEndpointsSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).listIndexEndpointsSettings();
}
/** Returns the object with the settings used for calls to updateIndexEndpoint. */
public UnaryCallSettings
updateIndexEndpointSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).updateIndexEndpointSettings();
}
/** Returns the object with the settings used for calls to deleteIndexEndpoint. */
public UnaryCallSettings deleteIndexEndpointSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).deleteIndexEndpointSettings();
}
/** Returns the object with the settings used for calls to deleteIndexEndpoint. */
public OperationCallSettings
deleteIndexEndpointOperationSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings())
.deleteIndexEndpointOperationSettings();
}
/** Returns the object with the settings used for calls to deployIndex. */
public UnaryCallSettings deployIndexSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).deployIndexSettings();
}
/** Returns the object with the settings used for calls to deployIndex. */
public OperationCallSettings<
DeployIndexRequest, DeployIndexResponse, DeployIndexOperationMetadata>
deployIndexOperationSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).deployIndexOperationSettings();
}
/** Returns the object with the settings used for calls to undeployIndex. */
public UnaryCallSettings undeployIndexSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).undeployIndexSettings();
}
/** Returns the object with the settings used for calls to undeployIndex. */
public OperationCallSettings<
UndeployIndexRequest, UndeployIndexResponse, UndeployIndexOperationMetadata>
undeployIndexOperationSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).undeployIndexOperationSettings();
}
/** Returns the object with the settings used for calls to mutateDeployedIndex. */
public UnaryCallSettings mutateDeployedIndexSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).mutateDeployedIndexSettings();
}
/** Returns the object with the settings used for calls to mutateDeployedIndex. */
public OperationCallSettings<
MutateDeployedIndexRequest,
MutateDeployedIndexResponse,
MutateDeployedIndexOperationMetadata>
mutateDeployedIndexOperationSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings())
.mutateDeployedIndexOperationSettings();
}
/** Returns the object with the settings used for calls to listLocations. */
public PagedCallSettings
listLocationsSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).listLocationsSettings();
}
/** Returns the object with the settings used for calls to getLocation. */
public UnaryCallSettings getLocationSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).getLocationSettings();
}
/** Returns the object with the settings used for calls to setIamPolicy. */
public UnaryCallSettings setIamPolicySettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).setIamPolicySettings();
}
/** Returns the object with the settings used for calls to getIamPolicy. */
public UnaryCallSettings getIamPolicySettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).getIamPolicySettings();
}
/** Returns the object with the settings used for calls to testIamPermissions. */
public UnaryCallSettings
testIamPermissionsSettings() {
return ((IndexEndpointServiceStubSettings) getStubSettings()).testIamPermissionsSettings();
}
public static final IndexEndpointServiceSettings create(IndexEndpointServiceStubSettings stub)
throws IOException {
return new IndexEndpointServiceSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return IndexEndpointServiceStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return IndexEndpointServiceStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return IndexEndpointServiceStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return IndexEndpointServiceStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return IndexEndpointServiceStubSettings.defaultGrpcTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return IndexEndpointServiceStubSettings.defaultTransportChannelProvider();
}
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return IndexEndpointServiceStubSettings.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 IndexEndpointServiceSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for IndexEndpointServiceSettings. */
public static class Builder
extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(IndexEndpointServiceStubSettings.newBuilder(clientContext));
}
protected Builder(IndexEndpointServiceSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(IndexEndpointServiceStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(IndexEndpointServiceStubSettings.newBuilder());
}
public IndexEndpointServiceStubSettings.Builder getStubSettingsBuilder() {
return ((IndexEndpointServiceStubSettings.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 createIndexEndpoint. */
public UnaryCallSettings.Builder
createIndexEndpointSettings() {
return getStubSettingsBuilder().createIndexEndpointSettings();
}
/** Returns the builder for the settings used for calls to createIndexEndpoint. */
public OperationCallSettings.Builder<
CreateIndexEndpointRequest, IndexEndpoint, CreateIndexEndpointOperationMetadata>
createIndexEndpointOperationSettings() {
return getStubSettingsBuilder().createIndexEndpointOperationSettings();
}
/** Returns the builder for the settings used for calls to getIndexEndpoint. */
public UnaryCallSettings.Builder
getIndexEndpointSettings() {
return getStubSettingsBuilder().getIndexEndpointSettings();
}
/** Returns the builder for the settings used for calls to listIndexEndpoints. */
public PagedCallSettings.Builder<
ListIndexEndpointsRequest, ListIndexEndpointsResponse, ListIndexEndpointsPagedResponse>
listIndexEndpointsSettings() {
return getStubSettingsBuilder().listIndexEndpointsSettings();
}
/** Returns the builder for the settings used for calls to updateIndexEndpoint. */
public UnaryCallSettings.Builder
updateIndexEndpointSettings() {
return getStubSettingsBuilder().updateIndexEndpointSettings();
}
/** Returns the builder for the settings used for calls to deleteIndexEndpoint. */
public UnaryCallSettings.Builder
deleteIndexEndpointSettings() {
return getStubSettingsBuilder().deleteIndexEndpointSettings();
}
/** Returns the builder for the settings used for calls to deleteIndexEndpoint. */
public OperationCallSettings.Builder
deleteIndexEndpointOperationSettings() {
return getStubSettingsBuilder().deleteIndexEndpointOperationSettings();
}
/** Returns the builder for the settings used for calls to deployIndex. */
public UnaryCallSettings.Builder deployIndexSettings() {
return getStubSettingsBuilder().deployIndexSettings();
}
/** Returns the builder for the settings used for calls to deployIndex. */
public OperationCallSettings.Builder<
DeployIndexRequest, DeployIndexResponse, DeployIndexOperationMetadata>
deployIndexOperationSettings() {
return getStubSettingsBuilder().deployIndexOperationSettings();
}
/** Returns the builder for the settings used for calls to undeployIndex. */
public UnaryCallSettings.Builder undeployIndexSettings() {
return getStubSettingsBuilder().undeployIndexSettings();
}
/** Returns the builder for the settings used for calls to undeployIndex. */
public OperationCallSettings.Builder<
UndeployIndexRequest, UndeployIndexResponse, UndeployIndexOperationMetadata>
undeployIndexOperationSettings() {
return getStubSettingsBuilder().undeployIndexOperationSettings();
}
/** Returns the builder for the settings used for calls to mutateDeployedIndex. */
public UnaryCallSettings.Builder
mutateDeployedIndexSettings() {
return getStubSettingsBuilder().mutateDeployedIndexSettings();
}
/** Returns the builder for the settings used for calls to mutateDeployedIndex. */
public OperationCallSettings.Builder<
MutateDeployedIndexRequest,
MutateDeployedIndexResponse,
MutateDeployedIndexOperationMetadata>
mutateDeployedIndexOperationSettings() {
return getStubSettingsBuilder().mutateDeployedIndexOperationSettings();
}
/** 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 IndexEndpointServiceSettings build() throws IOException {
return new IndexEndpointServiceSettings(this);
}
}
}