com.google.cloud.discoveryengine.v1alpha

Class EngineServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<EngineServiceSettings>

com.google.cloud.discoveryengine.v1alpha.EngineServiceSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class EngineServiceSettings
extends com.google.api.gax.rpc.ClientSettings<EngineServiceSettings>

Settings class to configure an instance of 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:

 // 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EngineServiceSettings.Builder Builder for EngineServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EngineServiceSettings(EngineServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static EngineServiceSettings	create(EngineServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateEngineRequest,Engine,CreateEngineMetadata>	createEngineOperationSettings() Returns the object with the settings used for calls to createEngine.
com.google.api.gax.rpc.UnaryCallSettings<CreateEngineRequest,com.google.longrunning.Operation>	createEngineSettings() Returns the object with the settings used for calls to createEngine.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteEngineRequest,com.google.protobuf.Empty,DeleteEngineMetadata>	deleteEngineOperationSettings() Returns the object with the settings used for calls to deleteEngine.
com.google.api.gax.rpc.UnaryCallSettings<DeleteEngineRequest,com.google.longrunning.Operation>	deleteEngineSettings() Returns the object with the settings used for calls to deleteEngine.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetEngineRequest,Engine>	getEngineSettings() Returns the object with the settings used for calls to getEngine.
com.google.api.gax.rpc.PagedCallSettings<ListEnginesRequest,ListEnginesResponse,EngineServiceClient.ListEnginesPagedResponse>	listEnginesSettings() Returns the object with the settings used for calls to listEngines.
static EngineServiceSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static EngineServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static EngineServiceSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<PauseEngineRequest,Engine>	pauseEngineSettings() Returns the object with the settings used for calls to pauseEngine.
com.google.api.gax.rpc.UnaryCallSettings<ResumeEngineRequest,Engine>	resumeEngineSettings() Returns the object with the settings used for calls to resumeEngine.
EngineServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<TuneEngineRequest,TuneEngineResponse,TuneEngineMetadata>	tuneEngineOperationSettings() Returns the object with the settings used for calls to tuneEngine.
com.google.api.gax.rpc.UnaryCallSettings<TuneEngineRequest,com.google.longrunning.Operation>	tuneEngineSettings() Returns the object with the settings used for calls to tuneEngine.
com.google.api.gax.rpc.UnaryCallSettings<UpdateEngineRequest,Engine>	updateEngineSettings() Returns the object with the settings used for calls to updateEngine.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EngineServiceSettings

protected EngineServiceSettings(EngineServiceSettings.Builder settingsBuilder)
                         throws IOException

Throws:

IOException

Method Detail

createEngineSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateEngineRequest,com.google.longrunning.Operation> createEngineSettings()

Returns the object with the settings used for calls to createEngine.

createEngineOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateEngineRequest,Engine,CreateEngineMetadata> createEngineOperationSettings()

Returns the object with the settings used for calls to createEngine.

deleteEngineSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteEngineRequest,com.google.longrunning.Operation> deleteEngineSettings()

Returns the object with the settings used for calls to deleteEngine.

deleteEngineOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteEngineRequest,com.google.protobuf.Empty,DeleteEngineMetadata> deleteEngineOperationSettings()

Returns the object with the settings used for calls to deleteEngine.

updateEngineSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateEngineRequest,Engine> updateEngineSettings()

Returns the object with the settings used for calls to updateEngine.

getEngineSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetEngineRequest,Engine> getEngineSettings()

Returns the object with the settings used for calls to getEngine.

listEnginesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListEnginesRequest,ListEnginesResponse,EngineServiceClient.ListEnginesPagedResponse> listEnginesSettings()

Returns the object with the settings used for calls to listEngines.

pauseEngineSettings

public com.google.api.gax.rpc.UnaryCallSettings<PauseEngineRequest,Engine> pauseEngineSettings()

Returns the object with the settings used for calls to pauseEngine.

resumeEngineSettings

public com.google.api.gax.rpc.UnaryCallSettings<ResumeEngineRequest,Engine> resumeEngineSettings()

Returns the object with the settings used for calls to resumeEngine.

tuneEngineSettings

public com.google.api.gax.rpc.UnaryCallSettings<TuneEngineRequest,com.google.longrunning.Operation> tuneEngineSettings()

Returns the object with the settings used for calls to tuneEngine.

tuneEngineOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<TuneEngineRequest,TuneEngineResponse,TuneEngineMetadata> tuneEngineOperationSettings()

Returns the object with the settings used for calls to tuneEngine.

create

public static final EngineServiceSettings create(EngineServiceStubSettings stub)
                                          throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static EngineServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static EngineServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static EngineServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public EngineServiceSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<EngineServiceSettings>