com.google.cloud.discoveryengine.v1alpha.EngineServiceSettings Maven / Gradle / Ivy
/*
* 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.discoveryengine.v1alpha;
import static com.google.cloud.discoveryengine.v1alpha.EngineServiceClient.ListEnginesPagedResponse;
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.httpjson.InstantiatingHttpJsonChannelProvider;
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.discoveryengine.v1alpha.stub.EngineServiceStubSettings;
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 EngineServiceClient}.
*
* The default instance has everything set to sensible defaults:
*
*
* - The default service address (discoveryengine.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 updateEngine 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
* EngineServiceSettings.Builder engineServiceSettingsBuilder = EngineServiceSettings.newBuilder();
* engineServiceSettingsBuilder
* .updateEngineSettings()
* .setRetrySettings(
* engineServiceSettingsBuilder
* .updateEngineSettings()
* .getRetrySettings()
* .toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* EngineServiceSettings engineServiceSettings = engineServiceSettingsBuilder.build();
* }
*/
@BetaApi
@Generated("by gapic-generator-java")
public class EngineServiceSettings extends ClientSettings {
/** Returns the object with the settings used for calls to createEngine. */
public UnaryCallSettings createEngineSettings() {
return ((EngineServiceStubSettings) getStubSettings()).createEngineSettings();
}
/** Returns the object with the settings used for calls to createEngine. */
public OperationCallSettings
createEngineOperationSettings() {
return ((EngineServiceStubSettings) getStubSettings()).createEngineOperationSettings();
}
/** Returns the object with the settings used for calls to deleteEngine. */
public UnaryCallSettings deleteEngineSettings() {
return ((EngineServiceStubSettings) getStubSettings()).deleteEngineSettings();
}
/** Returns the object with the settings used for calls to deleteEngine. */
public OperationCallSettings
deleteEngineOperationSettings() {
return ((EngineServiceStubSettings) getStubSettings()).deleteEngineOperationSettings();
}
/** Returns the object with the settings used for calls to updateEngine. */
public UnaryCallSettings updateEngineSettings() {
return ((EngineServiceStubSettings) getStubSettings()).updateEngineSettings();
}
/** Returns the object with the settings used for calls to getEngine. */
public UnaryCallSettings getEngineSettings() {
return ((EngineServiceStubSettings) getStubSettings()).getEngineSettings();
}
/** Returns the object with the settings used for calls to listEngines. */
public PagedCallSettings
listEnginesSettings() {
return ((EngineServiceStubSettings) getStubSettings()).listEnginesSettings();
}
/** Returns the object with the settings used for calls to pauseEngine. */
public UnaryCallSettings pauseEngineSettings() {
return ((EngineServiceStubSettings) getStubSettings()).pauseEngineSettings();
}
/** Returns the object with the settings used for calls to resumeEngine. */
public UnaryCallSettings resumeEngineSettings() {
return ((EngineServiceStubSettings) getStubSettings()).resumeEngineSettings();
}
/** Returns the object with the settings used for calls to tuneEngine. */
public UnaryCallSettings tuneEngineSettings() {
return ((EngineServiceStubSettings) getStubSettings()).tuneEngineSettings();
}
/** Returns the object with the settings used for calls to tuneEngine. */
public OperationCallSettings
tuneEngineOperationSettings() {
return ((EngineServiceStubSettings) getStubSettings()).tuneEngineOperationSettings();
}
public static final EngineServiceSettings create(EngineServiceStubSettings stub)
throws IOException {
return new EngineServiceSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return EngineServiceStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return EngineServiceStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return EngineServiceStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return EngineServiceStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return EngineServiceStubSettings.defaultGrpcTransportProviderBuilder();
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return EngineServiceStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return EngineServiceStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return EngineServiceStubSettings.defaultApiClientHeaderProviderBuilder();
}
/** Returns a new gRPC builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** Returns a new REST builder for this class. */
public static Builder newHttpJsonBuilder() {
return Builder.createHttpJsonDefault();
}
/** 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 EngineServiceSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for EngineServiceSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(EngineServiceStubSettings.newBuilder(clientContext));
}
protected Builder(EngineServiceSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(EngineServiceStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(EngineServiceStubSettings.newBuilder());
}
private static Builder createHttpJsonDefault() {
return new Builder(EngineServiceStubSettings.newHttpJsonBuilder());
}
public EngineServiceStubSettings.Builder getStubSettingsBuilder() {
return ((EngineServiceStubSettings.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 createEngine. */
public UnaryCallSettings.Builder createEngineSettings() {
return getStubSettingsBuilder().createEngineSettings();
}
/** Returns the builder for the settings used for calls to createEngine. */
public OperationCallSettings.Builder
createEngineOperationSettings() {
return getStubSettingsBuilder().createEngineOperationSettings();
}
/** Returns the builder for the settings used for calls to deleteEngine. */
public UnaryCallSettings.Builder deleteEngineSettings() {
return getStubSettingsBuilder().deleteEngineSettings();
}
/** Returns the builder for the settings used for calls to deleteEngine. */
public OperationCallSettings.Builder
deleteEngineOperationSettings() {
return getStubSettingsBuilder().deleteEngineOperationSettings();
}
/** Returns the builder for the settings used for calls to updateEngine. */
public UnaryCallSettings.Builder updateEngineSettings() {
return getStubSettingsBuilder().updateEngineSettings();
}
/** Returns the builder for the settings used for calls to getEngine. */
public UnaryCallSettings.Builder getEngineSettings() {
return getStubSettingsBuilder().getEngineSettings();
}
/** Returns the builder for the settings used for calls to listEngines. */
public PagedCallSettings.Builder<
ListEnginesRequest, ListEnginesResponse, ListEnginesPagedResponse>
listEnginesSettings() {
return getStubSettingsBuilder().listEnginesSettings();
}
/** Returns the builder for the settings used for calls to pauseEngine. */
public UnaryCallSettings.Builder pauseEngineSettings() {
return getStubSettingsBuilder().pauseEngineSettings();
}
/** Returns the builder for the settings used for calls to resumeEngine. */
public UnaryCallSettings.Builder resumeEngineSettings() {
return getStubSettingsBuilder().resumeEngineSettings();
}
/** Returns the builder for the settings used for calls to tuneEngine. */
public UnaryCallSettings.Builder tuneEngineSettings() {
return getStubSettingsBuilder().tuneEngineSettings();
}
/** Returns the builder for the settings used for calls to tuneEngine. */
public OperationCallSettings.Builder
tuneEngineOperationSettings() {
return getStubSettingsBuilder().tuneEngineOperationSettings();
}
@Override
public EngineServiceSettings build() throws IOException {
return new EngineServiceSettings(this);
}
}
}