com.google.cloud.aiplatform.v1beta1.DatasetServiceSettings Maven / Gradle / Ivy
Show all versions of google-cloud-aiplatform Show documentation
/*
* Copyright 2024 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.DatasetServiceClient.ListAnnotationsPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.DatasetServiceClient.ListDataItemsPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.DatasetServiceClient.ListDatasetVersionsPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.DatasetServiceClient.ListDatasetsPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.DatasetServiceClient.ListLocationsPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.DatasetServiceClient.ListSavedQueriesPagedResponse;
import static com.google.cloud.aiplatform.v1beta1.DatasetServiceClient.SearchDataItemsPagedResponse;
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.DatasetServiceStubSettings;
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 DatasetServiceClient}.
*
* 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 getDataset 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
* DatasetServiceSettings.Builder datasetServiceSettingsBuilder =
* DatasetServiceSettings.newBuilder();
* datasetServiceSettingsBuilder
* .getDatasetSettings()
* .setRetrySettings(
* datasetServiceSettingsBuilder
* .getDatasetSettings()
* .getRetrySettings()
* .toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* DatasetServiceSettings datasetServiceSettings = datasetServiceSettingsBuilder.build();
* }
*/
@BetaApi
@Generated("by gapic-generator-java")
public class DatasetServiceSettings extends ClientSettings {
/** Returns the object with the settings used for calls to createDataset. */
public UnaryCallSettings createDatasetSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).createDatasetSettings();
}
/** Returns the object with the settings used for calls to createDataset. */
public OperationCallSettings
createDatasetOperationSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).createDatasetOperationSettings();
}
/** Returns the object with the settings used for calls to getDataset. */
public UnaryCallSettings getDatasetSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).getDatasetSettings();
}
/** Returns the object with the settings used for calls to updateDataset. */
public UnaryCallSettings updateDatasetSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).updateDatasetSettings();
}
/** Returns the object with the settings used for calls to listDatasets. */
public PagedCallSettings
listDatasetsSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).listDatasetsSettings();
}
/** Returns the object with the settings used for calls to deleteDataset. */
public UnaryCallSettings deleteDatasetSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).deleteDatasetSettings();
}
/** Returns the object with the settings used for calls to deleteDataset. */
public OperationCallSettings
deleteDatasetOperationSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).deleteDatasetOperationSettings();
}
/** Returns the object with the settings used for calls to importData. */
public UnaryCallSettings importDataSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).importDataSettings();
}
/** Returns the object with the settings used for calls to importData. */
public OperationCallSettings
importDataOperationSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).importDataOperationSettings();
}
/** Returns the object with the settings used for calls to exportData. */
public UnaryCallSettings exportDataSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).exportDataSettings();
}
/** Returns the object with the settings used for calls to exportData. */
public OperationCallSettings
exportDataOperationSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).exportDataOperationSettings();
}
/** Returns the object with the settings used for calls to createDatasetVersion. */
public UnaryCallSettings createDatasetVersionSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).createDatasetVersionSettings();
}
/** Returns the object with the settings used for calls to createDatasetVersion. */
public OperationCallSettings<
CreateDatasetVersionRequest, DatasetVersion, CreateDatasetVersionOperationMetadata>
createDatasetVersionOperationSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).createDatasetVersionOperationSettings();
}
/** Returns the object with the settings used for calls to updateDatasetVersion. */
public UnaryCallSettings
updateDatasetVersionSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).updateDatasetVersionSettings();
}
/** Returns the object with the settings used for calls to deleteDatasetVersion. */
public UnaryCallSettings deleteDatasetVersionSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).deleteDatasetVersionSettings();
}
/** Returns the object with the settings used for calls to deleteDatasetVersion. */
public OperationCallSettings
deleteDatasetVersionOperationSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).deleteDatasetVersionOperationSettings();
}
/** Returns the object with the settings used for calls to getDatasetVersion. */
public UnaryCallSettings getDatasetVersionSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).getDatasetVersionSettings();
}
/** Returns the object with the settings used for calls to listDatasetVersions. */
public PagedCallSettings<
ListDatasetVersionsRequest, ListDatasetVersionsResponse, ListDatasetVersionsPagedResponse>
listDatasetVersionsSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).listDatasetVersionsSettings();
}
/** Returns the object with the settings used for calls to restoreDatasetVersion. */
public UnaryCallSettings
restoreDatasetVersionSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).restoreDatasetVersionSettings();
}
/** Returns the object with the settings used for calls to restoreDatasetVersion. */
public OperationCallSettings<
RestoreDatasetVersionRequest, DatasetVersion, RestoreDatasetVersionOperationMetadata>
restoreDatasetVersionOperationSettings() {
return ((DatasetServiceStubSettings) getStubSettings())
.restoreDatasetVersionOperationSettings();
}
/** Returns the object with the settings used for calls to listDataItems. */
public PagedCallSettings
listDataItemsSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).listDataItemsSettings();
}
/** Returns the object with the settings used for calls to searchDataItems. */
public PagedCallSettings<
SearchDataItemsRequest, SearchDataItemsResponse, SearchDataItemsPagedResponse>
searchDataItemsSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).searchDataItemsSettings();
}
/** Returns the object with the settings used for calls to listSavedQueries. */
public PagedCallSettings<
ListSavedQueriesRequest, ListSavedQueriesResponse, ListSavedQueriesPagedResponse>
listSavedQueriesSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).listSavedQueriesSettings();
}
/** Returns the object with the settings used for calls to deleteSavedQuery. */
public UnaryCallSettings deleteSavedQuerySettings() {
return ((DatasetServiceStubSettings) getStubSettings()).deleteSavedQuerySettings();
}
/** Returns the object with the settings used for calls to deleteSavedQuery. */
public OperationCallSettings
deleteSavedQueryOperationSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).deleteSavedQueryOperationSettings();
}
/** Returns the object with the settings used for calls to getAnnotationSpec. */
public UnaryCallSettings getAnnotationSpecSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).getAnnotationSpecSettings();
}
/** Returns the object with the settings used for calls to listAnnotations. */
public PagedCallSettings<
ListAnnotationsRequest, ListAnnotationsResponse, ListAnnotationsPagedResponse>
listAnnotationsSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).listAnnotationsSettings();
}
/** Returns the object with the settings used for calls to listLocations. */
public PagedCallSettings
listLocationsSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).listLocationsSettings();
}
/** Returns the object with the settings used for calls to getLocation. */
public UnaryCallSettings getLocationSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).getLocationSettings();
}
/** Returns the object with the settings used for calls to setIamPolicy. */
public UnaryCallSettings setIamPolicySettings() {
return ((DatasetServiceStubSettings) getStubSettings()).setIamPolicySettings();
}
/** Returns the object with the settings used for calls to getIamPolicy. */
public UnaryCallSettings getIamPolicySettings() {
return ((DatasetServiceStubSettings) getStubSettings()).getIamPolicySettings();
}
/** Returns the object with the settings used for calls to testIamPermissions. */
public UnaryCallSettings
testIamPermissionsSettings() {
return ((DatasetServiceStubSettings) getStubSettings()).testIamPermissionsSettings();
}
public static final DatasetServiceSettings create(DatasetServiceStubSettings stub)
throws IOException {
return new DatasetServiceSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return DatasetServiceStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return DatasetServiceStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return DatasetServiceStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return DatasetServiceStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return DatasetServiceStubSettings.defaultGrpcTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return DatasetServiceStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return DatasetServiceStubSettings.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 DatasetServiceSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for DatasetServiceSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(DatasetServiceStubSettings.newBuilder(clientContext));
}
protected Builder(DatasetServiceSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(DatasetServiceStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(DatasetServiceStubSettings.newBuilder());
}
public DatasetServiceStubSettings.Builder getStubSettingsBuilder() {
return ((DatasetServiceStubSettings.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 createDataset. */
public UnaryCallSettings.Builder createDatasetSettings() {
return getStubSettingsBuilder().createDatasetSettings();
}
/** Returns the builder for the settings used for calls to createDataset. */
public OperationCallSettings.Builder<
CreateDatasetRequest, Dataset, CreateDatasetOperationMetadata>
createDatasetOperationSettings() {
return getStubSettingsBuilder().createDatasetOperationSettings();
}
/** Returns the builder for the settings used for calls to getDataset. */
public UnaryCallSettings.Builder getDatasetSettings() {
return getStubSettingsBuilder().getDatasetSettings();
}
/** Returns the builder for the settings used for calls to updateDataset. */
public UnaryCallSettings.Builder updateDatasetSettings() {
return getStubSettingsBuilder().updateDatasetSettings();
}
/** Returns the builder for the settings used for calls to listDatasets. */
public PagedCallSettings.Builder<
ListDatasetsRequest, ListDatasetsResponse, ListDatasetsPagedResponse>
listDatasetsSettings() {
return getStubSettingsBuilder().listDatasetsSettings();
}
/** Returns the builder for the settings used for calls to deleteDataset. */
public UnaryCallSettings.Builder deleteDatasetSettings() {
return getStubSettingsBuilder().deleteDatasetSettings();
}
/** Returns the builder for the settings used for calls to deleteDataset. */
public OperationCallSettings.Builder
deleteDatasetOperationSettings() {
return getStubSettingsBuilder().deleteDatasetOperationSettings();
}
/** Returns the builder for the settings used for calls to importData. */
public UnaryCallSettings.Builder importDataSettings() {
return getStubSettingsBuilder().importDataSettings();
}
/** Returns the builder for the settings used for calls to importData. */
public OperationCallSettings.Builder<
ImportDataRequest, ImportDataResponse, ImportDataOperationMetadata>
importDataOperationSettings() {
return getStubSettingsBuilder().importDataOperationSettings();
}
/** Returns the builder for the settings used for calls to exportData. */
public UnaryCallSettings.Builder exportDataSettings() {
return getStubSettingsBuilder().exportDataSettings();
}
/** Returns the builder for the settings used for calls to exportData. */
public OperationCallSettings.Builder<
ExportDataRequest, ExportDataResponse, ExportDataOperationMetadata>
exportDataOperationSettings() {
return getStubSettingsBuilder().exportDataOperationSettings();
}
/** Returns the builder for the settings used for calls to createDatasetVersion. */
public UnaryCallSettings.Builder
createDatasetVersionSettings() {
return getStubSettingsBuilder().createDatasetVersionSettings();
}
/** Returns the builder for the settings used for calls to createDatasetVersion. */
public OperationCallSettings.Builder<
CreateDatasetVersionRequest, DatasetVersion, CreateDatasetVersionOperationMetadata>
createDatasetVersionOperationSettings() {
return getStubSettingsBuilder().createDatasetVersionOperationSettings();
}
/** Returns the builder for the settings used for calls to updateDatasetVersion. */
public UnaryCallSettings.Builder
updateDatasetVersionSettings() {
return getStubSettingsBuilder().updateDatasetVersionSettings();
}
/** Returns the builder for the settings used for calls to deleteDatasetVersion. */
public UnaryCallSettings.Builder
deleteDatasetVersionSettings() {
return getStubSettingsBuilder().deleteDatasetVersionSettings();
}
/** Returns the builder for the settings used for calls to deleteDatasetVersion. */
public OperationCallSettings.Builder<
DeleteDatasetVersionRequest, Empty, DeleteOperationMetadata>
deleteDatasetVersionOperationSettings() {
return getStubSettingsBuilder().deleteDatasetVersionOperationSettings();
}
/** Returns the builder for the settings used for calls to getDatasetVersion. */
public UnaryCallSettings.Builder
getDatasetVersionSettings() {
return getStubSettingsBuilder().getDatasetVersionSettings();
}
/** Returns the builder for the settings used for calls to listDatasetVersions. */
public PagedCallSettings.Builder<
ListDatasetVersionsRequest,
ListDatasetVersionsResponse,
ListDatasetVersionsPagedResponse>
listDatasetVersionsSettings() {
return getStubSettingsBuilder().listDatasetVersionsSettings();
}
/** Returns the builder for the settings used for calls to restoreDatasetVersion. */
public UnaryCallSettings.Builder
restoreDatasetVersionSettings() {
return getStubSettingsBuilder().restoreDatasetVersionSettings();
}
/** Returns the builder for the settings used for calls to restoreDatasetVersion. */
public OperationCallSettings.Builder<
RestoreDatasetVersionRequest, DatasetVersion, RestoreDatasetVersionOperationMetadata>
restoreDatasetVersionOperationSettings() {
return getStubSettingsBuilder().restoreDatasetVersionOperationSettings();
}
/** Returns the builder for the settings used for calls to listDataItems. */
public PagedCallSettings.Builder<
ListDataItemsRequest, ListDataItemsResponse, ListDataItemsPagedResponse>
listDataItemsSettings() {
return getStubSettingsBuilder().listDataItemsSettings();
}
/** Returns the builder for the settings used for calls to searchDataItems. */
public PagedCallSettings.Builder<
SearchDataItemsRequest, SearchDataItemsResponse, SearchDataItemsPagedResponse>
searchDataItemsSettings() {
return getStubSettingsBuilder().searchDataItemsSettings();
}
/** Returns the builder for the settings used for calls to listSavedQueries. */
public PagedCallSettings.Builder<
ListSavedQueriesRequest, ListSavedQueriesResponse, ListSavedQueriesPagedResponse>
listSavedQueriesSettings() {
return getStubSettingsBuilder().listSavedQueriesSettings();
}
/** Returns the builder for the settings used for calls to deleteSavedQuery. */
public UnaryCallSettings.Builder
deleteSavedQuerySettings() {
return getStubSettingsBuilder().deleteSavedQuerySettings();
}
/** Returns the builder for the settings used for calls to deleteSavedQuery. */
public OperationCallSettings.Builder
deleteSavedQueryOperationSettings() {
return getStubSettingsBuilder().deleteSavedQueryOperationSettings();
}
/** Returns the builder for the settings used for calls to getAnnotationSpec. */
public UnaryCallSettings.Builder
getAnnotationSpecSettings() {
return getStubSettingsBuilder().getAnnotationSpecSettings();
}
/** Returns the builder for the settings used for calls to listAnnotations. */
public PagedCallSettings.Builder<
ListAnnotationsRequest, ListAnnotationsResponse, ListAnnotationsPagedResponse>
listAnnotationsSettings() {
return getStubSettingsBuilder().listAnnotationsSettings();
}
/** 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 DatasetServiceSettings build() throws IOException {
return new DatasetServiceSettings(this);
}
}
}