com.google.cloud.aiplatform.v1beta1.ModelServiceSettings 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.ModelServiceClient.ListLocationsPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.ModelServiceClient.ListModelEvaluationSlicesPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.ModelServiceClient.ListModelEvaluationsPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.ModelServiceClient.ListModelVersionsPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.ModelServiceClient.ListModelsPagedResponse;
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.ModelServiceStubSettings;
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 ModelServiceClient}.
*
* 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 getModel 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
* ModelServiceSettings.Builder modelServiceSettingsBuilder = ModelServiceSettings.newBuilder();
* modelServiceSettingsBuilder
* .getModelSettings()
* .setRetrySettings(
* modelServiceSettingsBuilder
* .getModelSettings()
* .getRetrySettings()
* .toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* ModelServiceSettings modelServiceSettings = modelServiceSettingsBuilder.build();
* }
*/
@BetaApi
@Generated("by gapic-generator-java")
public class ModelServiceSettings extends ClientSettings {
/** Returns the object with the settings used for calls to uploadModel. */
public UnaryCallSettings uploadModelSettings() {
return ((ModelServiceStubSettings) getStubSettings()).uploadModelSettings();
}
/** Returns the object with the settings used for calls to uploadModel. */
public OperationCallSettings<
UploadModelRequest, UploadModelResponse, UploadModelOperationMetadata>
uploadModelOperationSettings() {
return ((ModelServiceStubSettings) getStubSettings()).uploadModelOperationSettings();
}
/** Returns the object with the settings used for calls to getModel. */
public UnaryCallSettings getModelSettings() {
return ((ModelServiceStubSettings) getStubSettings()).getModelSettings();
}
/** Returns the object with the settings used for calls to listModels. */
public PagedCallSettings
listModelsSettings() {
return ((ModelServiceStubSettings) getStubSettings()).listModelsSettings();
}
/** Returns the object with the settings used for calls to listModelVersions. */
public PagedCallSettings<
ListModelVersionsRequest, ListModelVersionsResponse, ListModelVersionsPagedResponse>
listModelVersionsSettings() {
return ((ModelServiceStubSettings) getStubSettings()).listModelVersionsSettings();
}
/** Returns the object with the settings used for calls to updateModel. */
public UnaryCallSettings updateModelSettings() {
return ((ModelServiceStubSettings) getStubSettings()).updateModelSettings();
}
/** Returns the object with the settings used for calls to updateExplanationDataset. */
public UnaryCallSettings
updateExplanationDatasetSettings() {
return ((ModelServiceStubSettings) getStubSettings()).updateExplanationDatasetSettings();
}
/** Returns the object with the settings used for calls to updateExplanationDataset. */
public OperationCallSettings<
UpdateExplanationDatasetRequest,
UpdateExplanationDatasetResponse,
UpdateExplanationDatasetOperationMetadata>
updateExplanationDatasetOperationSettings() {
return ((ModelServiceStubSettings) getStubSettings())
.updateExplanationDatasetOperationSettings();
}
/** Returns the object with the settings used for calls to deleteModel. */
public UnaryCallSettings deleteModelSettings() {
return ((ModelServiceStubSettings) getStubSettings()).deleteModelSettings();
}
/** Returns the object with the settings used for calls to deleteModel. */
public OperationCallSettings
deleteModelOperationSettings() {
return ((ModelServiceStubSettings) getStubSettings()).deleteModelOperationSettings();
}
/** Returns the object with the settings used for calls to deleteModelVersion. */
public UnaryCallSettings deleteModelVersionSettings() {
return ((ModelServiceStubSettings) getStubSettings()).deleteModelVersionSettings();
}
/** Returns the object with the settings used for calls to deleteModelVersion. */
public OperationCallSettings
deleteModelVersionOperationSettings() {
return ((ModelServiceStubSettings) getStubSettings()).deleteModelVersionOperationSettings();
}
/** Returns the object with the settings used for calls to mergeVersionAliases. */
public UnaryCallSettings mergeVersionAliasesSettings() {
return ((ModelServiceStubSettings) getStubSettings()).mergeVersionAliasesSettings();
}
/** Returns the object with the settings used for calls to exportModel. */
public UnaryCallSettings exportModelSettings() {
return ((ModelServiceStubSettings) getStubSettings()).exportModelSettings();
}
/** Returns the object with the settings used for calls to exportModel. */
public OperationCallSettings<
ExportModelRequest, ExportModelResponse, ExportModelOperationMetadata>
exportModelOperationSettings() {
return ((ModelServiceStubSettings) getStubSettings()).exportModelOperationSettings();
}
/** Returns the object with the settings used for calls to copyModel. */
public UnaryCallSettings copyModelSettings() {
return ((ModelServiceStubSettings) getStubSettings()).copyModelSettings();
}
/** Returns the object with the settings used for calls to copyModel. */
public OperationCallSettings
copyModelOperationSettings() {
return ((ModelServiceStubSettings) getStubSettings()).copyModelOperationSettings();
}
/** Returns the object with the settings used for calls to importModelEvaluation. */
public UnaryCallSettings
importModelEvaluationSettings() {
return ((ModelServiceStubSettings) getStubSettings()).importModelEvaluationSettings();
}
/** Returns the object with the settings used for calls to batchImportModelEvaluationSlices. */
public UnaryCallSettings<
BatchImportModelEvaluationSlicesRequest, BatchImportModelEvaluationSlicesResponse>
batchImportModelEvaluationSlicesSettings() {
return ((ModelServiceStubSettings) getStubSettings())
.batchImportModelEvaluationSlicesSettings();
}
/** Returns the object with the settings used for calls to batchImportEvaluatedAnnotations. */
public UnaryCallSettings<
BatchImportEvaluatedAnnotationsRequest, BatchImportEvaluatedAnnotationsResponse>
batchImportEvaluatedAnnotationsSettings() {
return ((ModelServiceStubSettings) getStubSettings()).batchImportEvaluatedAnnotationsSettings();
}
/** Returns the object with the settings used for calls to getModelEvaluation. */
public UnaryCallSettings
getModelEvaluationSettings() {
return ((ModelServiceStubSettings) getStubSettings()).getModelEvaluationSettings();
}
/** Returns the object with the settings used for calls to listModelEvaluations. */
public PagedCallSettings<
ListModelEvaluationsRequest,
ListModelEvaluationsResponse,
ListModelEvaluationsPagedResponse>
listModelEvaluationsSettings() {
return ((ModelServiceStubSettings) getStubSettings()).listModelEvaluationsSettings();
}
/** Returns the object with the settings used for calls to getModelEvaluationSlice. */
public UnaryCallSettings
getModelEvaluationSliceSettings() {
return ((ModelServiceStubSettings) getStubSettings()).getModelEvaluationSliceSettings();
}
/** Returns the object with the settings used for calls to listModelEvaluationSlices. */
public PagedCallSettings<
ListModelEvaluationSlicesRequest,
ListModelEvaluationSlicesResponse,
ListModelEvaluationSlicesPagedResponse>
listModelEvaluationSlicesSettings() {
return ((ModelServiceStubSettings) getStubSettings()).listModelEvaluationSlicesSettings();
}
/** Returns the object with the settings used for calls to listLocations. */
public PagedCallSettings
listLocationsSettings() {
return ((ModelServiceStubSettings) getStubSettings()).listLocationsSettings();
}
/** Returns the object with the settings used for calls to getLocation. */
public UnaryCallSettings getLocationSettings() {
return ((ModelServiceStubSettings) getStubSettings()).getLocationSettings();
}
/** Returns the object with the settings used for calls to setIamPolicy. */
public UnaryCallSettings setIamPolicySettings() {
return ((ModelServiceStubSettings) getStubSettings()).setIamPolicySettings();
}
/** Returns the object with the settings used for calls to getIamPolicy. */
public UnaryCallSettings getIamPolicySettings() {
return ((ModelServiceStubSettings) getStubSettings()).getIamPolicySettings();
}
/** Returns the object with the settings used for calls to testIamPermissions. */
public UnaryCallSettings
testIamPermissionsSettings() {
return ((ModelServiceStubSettings) getStubSettings()).testIamPermissionsSettings();
}
public static final ModelServiceSettings create(ModelServiceStubSettings stub)
throws IOException {
return new ModelServiceSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return ModelServiceStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return ModelServiceStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return ModelServiceStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return ModelServiceStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return ModelServiceStubSettings.defaultGrpcTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return ModelServiceStubSettings.defaultTransportChannelProvider();
}
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return ModelServiceStubSettings.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 ModelServiceSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for ModelServiceSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(ModelServiceStubSettings.newBuilder(clientContext));
}
protected Builder(ModelServiceSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(ModelServiceStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(ModelServiceStubSettings.newBuilder());
}
public ModelServiceStubSettings.Builder getStubSettingsBuilder() {
return ((ModelServiceStubSettings.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 uploadModel. */
public UnaryCallSettings.Builder uploadModelSettings() {
return getStubSettingsBuilder().uploadModelSettings();
}
/** Returns the builder for the settings used for calls to uploadModel. */
public OperationCallSettings.Builder<
UploadModelRequest, UploadModelResponse, UploadModelOperationMetadata>
uploadModelOperationSettings() {
return getStubSettingsBuilder().uploadModelOperationSettings();
}
/** Returns the builder for the settings used for calls to getModel. */
public UnaryCallSettings.Builder getModelSettings() {
return getStubSettingsBuilder().getModelSettings();
}
/** Returns the builder for the settings used for calls to listModels. */
public PagedCallSettings.Builder
listModelsSettings() {
return getStubSettingsBuilder().listModelsSettings();
}
/** Returns the builder for the settings used for calls to listModelVersions. */
public PagedCallSettings.Builder<
ListModelVersionsRequest, ListModelVersionsResponse, ListModelVersionsPagedResponse>
listModelVersionsSettings() {
return getStubSettingsBuilder().listModelVersionsSettings();
}
/** Returns the builder for the settings used for calls to updateModel. */
public UnaryCallSettings.Builder updateModelSettings() {
return getStubSettingsBuilder().updateModelSettings();
}
/** Returns the builder for the settings used for calls to updateExplanationDataset. */
public UnaryCallSettings.Builder
updateExplanationDatasetSettings() {
return getStubSettingsBuilder().updateExplanationDatasetSettings();
}
/** Returns the builder for the settings used for calls to updateExplanationDataset. */
public OperationCallSettings.Builder<
UpdateExplanationDatasetRequest,
UpdateExplanationDatasetResponse,
UpdateExplanationDatasetOperationMetadata>
updateExplanationDatasetOperationSettings() {
return getStubSettingsBuilder().updateExplanationDatasetOperationSettings();
}
/** Returns the builder for the settings used for calls to deleteModel. */
public UnaryCallSettings.Builder deleteModelSettings() {
return getStubSettingsBuilder().deleteModelSettings();
}
/** Returns the builder for the settings used for calls to deleteModel. */
public OperationCallSettings.Builder
deleteModelOperationSettings() {
return getStubSettingsBuilder().deleteModelOperationSettings();
}
/** Returns the builder for the settings used for calls to deleteModelVersion. */
public UnaryCallSettings.Builder
deleteModelVersionSettings() {
return getStubSettingsBuilder().deleteModelVersionSettings();
}
/** Returns the builder for the settings used for calls to deleteModelVersion. */
public OperationCallSettings.Builder
deleteModelVersionOperationSettings() {
return getStubSettingsBuilder().deleteModelVersionOperationSettings();
}
/** Returns the builder for the settings used for calls to mergeVersionAliases. */
public UnaryCallSettings.Builder
mergeVersionAliasesSettings() {
return getStubSettingsBuilder().mergeVersionAliasesSettings();
}
/** Returns the builder for the settings used for calls to exportModel. */
public UnaryCallSettings.Builder exportModelSettings() {
return getStubSettingsBuilder().exportModelSettings();
}
/** Returns the builder for the settings used for calls to exportModel. */
public OperationCallSettings.Builder<
ExportModelRequest, ExportModelResponse, ExportModelOperationMetadata>
exportModelOperationSettings() {
return getStubSettingsBuilder().exportModelOperationSettings();
}
/** Returns the builder for the settings used for calls to copyModel. */
public UnaryCallSettings.Builder copyModelSettings() {
return getStubSettingsBuilder().copyModelSettings();
}
/** Returns the builder for the settings used for calls to copyModel. */
public OperationCallSettings.Builder<
CopyModelRequest, CopyModelResponse, CopyModelOperationMetadata>
copyModelOperationSettings() {
return getStubSettingsBuilder().copyModelOperationSettings();
}
/** Returns the builder for the settings used for calls to importModelEvaluation. */
public UnaryCallSettings.Builder
importModelEvaluationSettings() {
return getStubSettingsBuilder().importModelEvaluationSettings();
}
/** Returns the builder for the settings used for calls to batchImportModelEvaluationSlices. */
public UnaryCallSettings.Builder<
BatchImportModelEvaluationSlicesRequest, BatchImportModelEvaluationSlicesResponse>
batchImportModelEvaluationSlicesSettings() {
return getStubSettingsBuilder().batchImportModelEvaluationSlicesSettings();
}
/** Returns the builder for the settings used for calls to batchImportEvaluatedAnnotations. */
public UnaryCallSettings.Builder<
BatchImportEvaluatedAnnotationsRequest, BatchImportEvaluatedAnnotationsResponse>
batchImportEvaluatedAnnotationsSettings() {
return getStubSettingsBuilder().batchImportEvaluatedAnnotationsSettings();
}
/** Returns the builder for the settings used for calls to getModelEvaluation. */
public UnaryCallSettings.Builder
getModelEvaluationSettings() {
return getStubSettingsBuilder().getModelEvaluationSettings();
}
/** Returns the builder for the settings used for calls to listModelEvaluations. */
public PagedCallSettings.Builder<
ListModelEvaluationsRequest,
ListModelEvaluationsResponse,
ListModelEvaluationsPagedResponse>
listModelEvaluationsSettings() {
return getStubSettingsBuilder().listModelEvaluationsSettings();
}
/** Returns the builder for the settings used for calls to getModelEvaluationSlice. */
public UnaryCallSettings.Builder
getModelEvaluationSliceSettings() {
return getStubSettingsBuilder().getModelEvaluationSliceSettings();
}
/** Returns the builder for the settings used for calls to listModelEvaluationSlices. */
public PagedCallSettings.Builder<
ListModelEvaluationSlicesRequest,
ListModelEvaluationSlicesResponse,
ListModelEvaluationSlicesPagedResponse>
listModelEvaluationSlicesSettings() {
return getStubSettingsBuilder().listModelEvaluationSlicesSettings();
}
/** 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 ModelServiceSettings build() throws IOException {
return new ModelServiceSettings(this);
}
}
}